Skip to content

Improve README copywriting#14

Merged
joyzoursky merged 1 commit intomainfrom
improve-readme
Feb 6, 2026
Merged

Improve README copywriting#14
joyzoursky merged 1 commit intomainfrom
improve-readme

Conversation

@chpapa
Copy link
Copy Markdown
Member

@chpapa chpapa commented Feb 4, 2026

Summary

  • Tighten intro paragraph: cut filler words, use active voice, remove wordy constructions
  • Replace em dashes with hyphens in feature and contributing lists to reduce AI-writing patterns
  • Remove redundant negative constructions ("No X, no Y, no Z") in favor of concise positive statements
  • Cut needless qualifiers ("real", "exactly", "across your test suite") throughout

Test plan

  • Verify README renders correctly on GitHub
  • Check all links still work

🤖 Generated with Claude Code

@chpapa chpapa requested a review from joyzoursky February 4, 2026 11:40
@chpapa
Copy link
Copy Markdown
Member Author

chpapa commented Feb 4, 2026

Sorry still learning how to use AI to interact with Github lol.. obviously it missed the most important change is the video cover screen... @joyzoursky See if you think the changes are good?

Comment thread README.md Outdated
<video src="https://github.com/user-attachments/assets/adcfa63d-279c-4e8f-9d34-d950678a4255"></video>
It is self-hosted, open source, and uses your own API key.

<video src="https://github.com/user-attachments/assets/c6570684-8362-495c-bfb8-10cf59ea644b"></video>
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@chpapa I cannot view the video by accessing the link. Is this a different video from the original one?

@chpapa
Copy link
Copy Markdown
Member Author

chpapa commented Feb 5, 2026

538466119-adcfa63d-279c-4e8f-9d34-d950678a4255-fixed.mp4

Sorry it should be this video

@joyzoursky
Copy link
Copy Markdown
Collaborator

@chpapa Please also change the video name (e.g. Welcome.mp4) as it will be shown on the Readme page. And please update the new link in the pull request commit, thanks.

@chpapa
Copy link
Copy Markdown
Member Author

chpapa commented Feb 6, 2026

Welcome.mp4

Tighten prose, cut filler, and remove AI-writing patterns from the
README. Replace em dashes with hyphens in lists, rewrite the intro
for conciseness, and remove redundant negative constructions.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@chpapa
Copy link
Copy Markdown
Member Author

chpapa commented Feb 6, 2026

@joyzoursky updated

@joyzoursky joyzoursky merged commit aff711f into main Feb 6, 2026
@joyzoursky joyzoursky deleted the improve-readme branch February 6, 2026 04:50
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.

2 participants