Skip to content

Rewrite the README - #19

Merged
mobrava merged 1 commit into
mainfrom
docs/readme-rewrite
Aug 29, 2026
Merged

Rewrite the README#19
mobrava merged 1 commit into
mainfrom
docs/readme-rewrite

Conversation

@mobrava

@mobrava mobrava commented Aug 29, 2026

Copy link
Copy Markdown
Owner

Removes every table and the repeated bold-label bullet lists, and adds the sections the README was missing.

Removed

  • Competitor comparison table (two of its five rows carried no information: every column said yes to notarization, and the interface row was identical to Paste)
  • Tech stack table, folded into one sentence under Build from source
  • Build comparison table, folded into a details block under Install
  • Fourteen **Label:** sentence bullets across Highlights and Privacy
  • Trailing star request and the rename callout above the badges

Added

  • FAQ: why the app does not paste for you, shortcut conflicts, images in terminals, where history is stored and how to delete it, the PasteClip rename
  • Motivation section
  • Uninstall instructions, which were missing

Corrected

  • Dropped the "code snippets" capture claim. ContentType has no code case; code is only rendered in a monospaced font when indicators are found
  • The no-auto-paste behaviour is now documented as intentional, matching the fact that the app links no Accessibility or CGEvent APIs

221 lines to 169. README.zh-CN.md is untouched in this PR.

The feature and privacy sections were fourteen bullets of the same
bold-label shape, and three tables carried little information: a
competitor comparison with rows where every column said yes, a tech
stack listing, and a build comparison. All of them are gone.

What replaces them: a plain intro, a short feature list, an FAQ built
from questions users actually ask (why it does not paste for you, where
the history lives and how to delete it, why images behave differently in
terminals), and a Motivation section that says why the app exists.

The install section keeps the three channels and folds the build
comparison and migration steps into a details block. Dropped the
'code snippets' claim, since code is only rendered in a monospaced font.
@mobrava
mobrava merged commit df423f6 into main Aug 29, 2026
1 check passed
@mobrava
mobrava deleted the docs/readme-rewrite branch August 29, 2026 02:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant