docs: refresh root README around the three Stack pillars#526
Conversation
- Lead with a searchable-encryption value prop and zero-knowledge trust line - Account-first quick start; show encrypt + search-without-decrypt + decrypt - Cover all three pillars early: searchable encryption, ORM integrations (Supabase/Drizzle/Prisma Next/DynamoDB), identity-aware encryption - Add a 'How it works' section linking the security architecture docs - Use reference-style links with all URLs centralised at the bottom (CipherStash links carry README UTM params) - Mark @cipherstash/protect (Protect.js) as legacy in its README - Spec the architecture diagram + type-safety GIF in docs/plans
|
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Reflects the auth changes in #497: replace the deprecated LockContext.identify() ceremony with client-level OidcFederationStrategy + .withLockContext({ identityClaim }), which makes every OIDC provider (Clerk, Supabase, Auth0, Okta) first-class.
What
A conversion-focused rewrite of the root
README.md, benchmarked against 8 company-backed, high-star OSS READMEs (Supabase, Clerk, Infisical, Vault, Trigger.dev, Prisma, Drizzle, React Email).The README now:
npx stash init, then a snippet that shows encrypt → search without decrypting → decrypt.?utm_source=github&utm_medium=stack_readmefor attribution.Also in this PR:
@cipherstash/protect(Protect.js) as legacy with a warning banner at the top of its README.docs/plans/readme-visual-assets.md— specs for two net-new assets (architecture diagram + type-safety autocomplete GIF), including a ship-today Mermaid version of the diagram.Auth section — now reflects #497 (
OidcFederationStrategy)The identity-aware encryption pillar has been updated to the new strategy-based API from #497: client-level
OidcFederationStrategy(config.strategy, re-exported from@cipherstash/stack) +.withLockContext({ identityClaim }), replacing the deprecatednew LockContext()→identify()→.withLockContext(lc)ceremony. This makes every OIDC provider (Clerk, Supabase, Auth0, Okta) first-class. The snippet mirrors #497's own documented example (OidcFederationStrategy.create(workspaceCrn, () => getUserJwt())).Other follow-ups
npm deprecate @cipherstash/protect— being handled separately (npm not authed in the build env).docs/plans/readme-visual-assets.md.mainonce feat(stack): protect-ffi 0.26.0 + auth 0.39 OidcFederationStrategy (stacked on #496) #497 merges (this PR rewrote the whole README, so expect to resolve a README.md conflict in favour of this branch).Notes for reviewers
cipherstash.comlinks) matches what analytics expects — easy to dial back since they're all in one block.