Skip to content

docs: write full README#5

Merged
Apetuezekiel merged 1 commit into
mainfrom
docs/readme
May 16, 2026
Merged

docs: write full README#5
Apetuezekiel merged 1 commit into
mainfrom
docs/readme

Conversation

@Apetuezekiel

Copy link
Copy Markdown
Owner

What

Replaces the stub README with complete library documentation.

Sections:

  • Installation
  • 60-second quick start (defineConfig + createAccess + diff)
  • Full API reference: defineConfig, createAccess, AccessChecker (can/cannot/guard/diff), Overrides, AccessDeniedError, InvalidOverrideError, Limit, ConfigInput/PlanInput schema
  • Override examples: grandfathering (grant) and compliance removal (revoke)
  • Diff example for upgrade prompt rendering
  • Dynamic config section: how literal inference is lost with JSON input and how to use the JSON Schema to validate it
  • "What the library does not do": usage tracking, period reset, persistence, remote config, auth, billing, framework bindings — all explicitly enumerated
  • Framework glue patterns (React hook, Express middleware) — documentation only, not published
  • Comparison to LaunchDarkly and Stripe Entitlements
  • Versioning and stability policy (semver, 0.x caveat)

Why

Implements PR 5 from the v1 scope. The README is the primary onboarding surface; without it, the library is unusable regardless of code quality.

How to verify

Read the rendered README on GitHub. Verify:

  • All exported symbols are documented
  • what the library does not do section explicitly names the items from the brief
  • Dynamic config section explains type inference loss
  • Versioning section mentions 0.x instability caveat

Out of scope

  • CHANGELOG — PR 6
  • Version bump — PR 6

@Apetuezekiel Apetuezekiel merged commit 1ef0367 into main May 16, 2026
5 checks passed
@Apetuezekiel Apetuezekiel deleted the docs/readme branch May 16, 2026 17:51
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