Skip to content

📚 docs: readme: open with an image, a pitch, the install, and an example - #513

Merged
pascalandy merged 1 commit into
mainfrom
docs/readme-hero
Nov 21, 2026
Merged

pascalandy merged 1 commit into
mainfrom
docs/readme-hero

Conversation

@pascalandy

Copy link
Copy Markdown
Owner

Outside the plan: a README change Pascal asked for.

Problem

The top of the README did not tell a stranger what Nicely is or how to try it. It opened with one dense sentence and a list of commands, with no image, and the install steps came far below.

Solution

  • Add the illustration as docs/assets/hero.png (1280x640) and show it first, with alt text
  • Keep the one-line pitch, then give the Homebrew install command, with a link to Install for Linux
  • Add one example that works on a fresh install, ncly skill list, with its real output
  • Remove ncly skill list from the command list below it, because the example now shows it. The rest of the README does not change

Proof: ncly skill list (v0.27.0, empty HOME) prints the four bundled skills nicely, nicely-auth, nicely-extensions, nicely-runs and exits 0, which is the output the README shows.

- [x] 1. Spec: n/a, no command, flag, key, or code changes
- [x] 2. Scenario: n/a, docs only
- [x] 3. Code: n/a, docs only
- [x] 4. Text: n/a, no user-facing string in the binary
- [x] 5. Checks: fmt-check, lint, tidy-check, test, template, python, release-lint, gitleaks-rules, gitleaks, and limits pass. In race, TestSignalTimeoutBoundsStreams went past its 25s limit (25.99s) on a busy machine, then passed alone in 22.7s
- [x] 6. Verify: n/a, no feature changes
- [x] 7. Docs: the README is the change
- [ ] 8. Sign off: left for Pascal

by Opus-5.5 via Claude Code

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Nov 20, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 676ee12e-a610-4242-90f3-e950530f5b88

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@pascalandy
pascalandy merged commit 38756a1 into main Nov 21, 2026
3 checks passed
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