docs: README conversion polish — value-prop bullets, Try Ornn free, star CTA#641
Open
chronoai-shining wants to merge 4 commits into
Open
docs: README conversion polish — value-prop bullets, Try Ornn free, star CTA#641chronoai-shining wants to merge 4 commits into
chronoai-shining wants to merge 4 commits into
Conversation
Refactor the section so the three reasons-to-care are scannable in a single glance instead of being threaded through flowing prose: - Agents call it directly (HTTP / MCP, no human-in-the-loop UI) - Model + runtime agnostic (Claude / GPT / Gemini / custom) - Whole lifecycle in one API (search → ... → share) The original "primary consumer" and "ornn-web is secondary" sentences fold into a single closing paragraph to avoid duplication with the bullets. The "agent-facing, not human marketplace" lead sentence stays verbatim — that's the framing every downstream channel (HN, Reddit, dev.to) hooks into. No content removed, only reorganized; the lifecycle sequence is preserved as inline code on the third bullet instead of a stand-alone fenced block.
Standard early-stage OSS pattern. One short paragraph between the Contributing section and the License section, acknowledging that stars double as both a "this is solving a real problem" signal and the threshold most awesome-list maintainers check before accepting a project. Deliberately not added as a banner / shields.io badge — at 12 stars a "please star us" hero is more harmful than helpful; a quiet near-the- bottom CTA reads as authentic instead of needy. Not added to the top-of-README ToC since it's a CTA paragraph, not a content section.
Insert a new section between Quickstart and "How Ornn compares" that hooks readers at the moment they've just learned what Ornn does + how to install it. Three-step redemption (star → sign in → enter NyxID invite code NYX-2XXJI08A) plus the launch perk (first 500 users get 400 free GPT-5.5 conversations, split between Playground and Skill Generation, no credit card, no expiry). Matching anchor link added to the top-of-README ToC so the section is reachable from the nav row, between Quickstart and How Ornn compares. Placement rationale: above the comparison table — once the reader has seen the value prop and how to use it, the perk converts; placing it below the comparison or at the bottom dilutes the "I get it, let me try" moment.
Required by CI (changeset gate). Empty frontmatter so no package version is bumped — README polish doesn't change the public surface.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Three conversion-focused additions to
README.mdahead of launch traffic. Visitors landing from upcoming external channels (HN, Reddit, dev.to, Awesome List PRs) currently have to scroll past the architecture diagram and SDK quickstart before the strongest hooks land — this PR moves them above the fold.Linked issue
Closes #640
Type of change
docs:)Commit decomposition
Co-Authored-Bytrailers.Four atomic commits:
docs: elevate value-prop bullets in "What is Ornn" (#640)— refactor only, no content removed. Lifecycle sequence preserved as inline code on the third bullet.docs: add star call-to-action section above License (#640)— additive paragraph between Contributing and License; not added to ToC since it's a CTA, not a content section.docs: add "Try Ornn free" launch perk section after Quickstart (#640)— additive section between Quickstart and "How Ornn compares" + matching ToC anchor.chore: empty changeset for docs-only README polish (#640)— required by CI gate.Changeset
bun changeset --empty).File:
.changeset/readme-conversion-polish-640.md.Testing
Local render verified against GitHub's markdown preview (matches the live README's anchor + bullet styling). No code paths touched, so unit / integration / lint / typecheck behaviour is unchanged — CI runs as a regression gate only.
Notes for the reviewer
What is Ornnsection keeps the "agent-facing skill-lifecycle API, not a human marketplace" lead sentence verbatim — that framing is the hook every downstream channel (HN, Reddit, dev.to) builds on, so any rewording should land in a follow-up after the launch dust settles.What is Ornn) is deferred to a follow-up — decision still open on whether to inline-host or external-link to the marketing repo'simage_1_what_is_ornn.png.