Skip to content

Update README to match organization template - #177

Merged
joeblau merged 1 commit into
mainfrom
cursor/update-readme-template-5eec
Oct 12, 2026
Merged

joeblau merged 1 commit into
mainfrom
cursor/update-readme-template-5eec

Conversation

@joeblau

@joeblau joeblau commented Oct 12, 2026

Copy link
Copy Markdown

Summary

This PR updates the root README.md to match the organization's README template (from bloxwap/.github PR #5), using the sfx repository README as a reference for section order and voice.

Changes Made

Structure & Sections

  • Tagline: Fixed casing to "TypeScript" and added "Try the documentation" link as specified in template
  • Section reordering: Moved Installation section before Development section to match template structure
  • Section renames:
    • "Workspace" → "Development"
    • "Quick Example" → "Usage"
  • New sections added:
    • Release status (based on v0.6.0 from package.json)
    • Security (moved private key warning into template's Security callout)
    • License (with linked MIT license reference)

Content Updates

  • Features section: Rewritten in "Bold. Sentence." voice with no em-dashes, matching sfx style
  • Coverage note: Added "Coverage target is 100% line, branch, and function coverage" in Development section (CI uploads to Codecov but doesn't enforce 100%)
  • Security callout: Consolidated private key and agent wallet warnings into a dedicated Security section
  • Maintained:
    • All flat-square badges (npm, downloads, Codecov, bundle-size)
    • All existing links remain valid
    • Bun commands throughout
    • Docs dev server on port 3901
    • All three usage examples (Read, Trade, Subscribe)

Build Verification

All builds passed successfully:

Main Build

$ bun run build
Published consumer imports, identities, nonce sharing, signing ownership, and error types passed.
Built @bloxwap/[email protected] into dist/ (313 JavaScript files, 314 declaration files rewritten).

Docs Build

$ cd apps/docs && bun run build
✓ Compiled successfully in 10.4s
✓ Generating static pages using 3 workers (37/37) in 928ms
Exported 13 Markdown mirrors.
Verified 13 docs pages, 20 HTML files, 1185 internal links/assets, 355 anchors, 14 unique social cards, static search, 22 agent-readiness artifacts, and .nojekyll (base path: /).

Both the SDK build and documentation build completed successfully with no errors.

Open in Web Open in Cursor 

- Fix tagline casing (TypeScript) and add docs link
- Reorder sections: Installation before Development
- Rename Workspace to Development, Quick Example to Usage
- Rewrite Features in 'Bold. Sentence.' voice with no em-dashes
- Add release-status line based on package version 0.6.0
- Add coverage target note (100% is target, not enforced)
- Add Security section with private key/agent wallet warning
- Add License section with linked MIT license
- Keep flat-square badges and all existing links
- Maintain Bun commands and docs port 3901

Co-authored-by: Joe Blau <[email protected]>
@joeblau
joeblau marked this pull request as ready for review October 12, 2026 23:46
@joeblau
joeblau merged commit 4a312a2 into main Oct 12, 2026
6 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.

2 participants