Skip to content

docs: rewrite README + add API.md#2

Merged
vaibhav1312 merged 1 commit intomainfrom
docs/readme-rewrite
Mar 27, 2026
Merged

docs: rewrite README + add API.md#2
vaibhav1312 merged 1 commit intomainfrom
docs/readme-rewrite

Conversation

@vaibhav1312
Copy link
Copy Markdown
Collaborator

Changes

README.md — Complete rewrite following ComposeYogi/tiptap patterns:

  • Centered hero with badges
  • "Why this library?" comparison table vs competitors
  • Quick Start (install + 3 lines)
  • Features bullet list
  • Usage examples (7 real, verified code snippets)
  • Charset table
  • Phased roadmap with checkboxes
  • Contributing section
  • About + License

API.md — Full API reference moved out of README:

  • Every exported function with signature, options table, and examples
  • All TypeScript interfaces documented
  • Organized by module (encode, decode, charsets, prosigns, timing, stats, validation)

.gitignore — Added PROJECT_PLAN.md (internal strategy doc)

- README: hero section, comparison table, quick start, features,
  usage examples, charset table, phased roadmap, contributing, about
- API.md: full reference for all exports with types and examples
- .gitignore: exclude PROJECT_PLAN.md (internal strategy doc)
@vaibhav1312 vaibhav1312 merged commit 2e32818 into main Mar 27, 2026
4 checks passed
@vaibhav1312 vaibhav1312 deleted the docs/readme-rewrite branch March 27, 2026 14:26
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