Skip to content

docs(readme): lead with what the app does and show it - #88

Merged
m1ngsama merged 1 commit into
mainfrom
docs/readme-focus
Sep 28, 2026
Merged

m1ngsama merged 1 commit into
mainfrom
docs/readme-focus

Conversation

@m1ngsama

Copy link
Copy Markdown
Member

A first-time reader should see what Prompt does and what it looks like before any details.

Decision: adds a 17.7 KB lossless WebP screenshot of the Events tab (.github/screenshot.webp), rendered from fixture events with no real names. It stays out of the npm package; npm shows it through the repository link.

  • Opens with the four things Prompt shows and that loaded data stays readable offline.
  • Cuts the command block from 15 lines to 7 common ones; nbtca --help covers the rest.
  • Shortens the security note to one sentence.

@m1ngsama
m1ngsama merged commit 2b8104e into main Sep 28, 2026
4 checks passed
@m1ngsama
m1ngsama deleted the docs/readme-focus branch September 28, 2026 05:18
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