Skip to content

docs(identifiabl): fix Quick Start to use the real export name#38

Open
davidcrowe wants to merge 1 commit into
mainfrom
fix/identifiabl-readme-export
Open

docs(identifiabl): fix Quick Start to use the real export name#38
davidcrowe wants to merge 1 commit into
mainfrom
fix/identifiabl-readme-export

Conversation

@davidcrowe

Copy link
Copy Markdown
Collaborator

Problem

The identifiabl README's Basic Usage (and three later examples) import and call createIdentifiablMiddleware — an export that does not exist. The package exports identifiabl(config) (the Express middleware) and createIdentifiablVerifier(config) (the non-Express verifier). A reader copy-pasting the Quick Start fails at the very first line:

import { createIdentifiablMiddleware } from '@gatewaystack/identifiabl';
//       ^ not exported

For the identity layer that the whole stack builds on — and during a repo-visibility push — a broken headline example is exactly the wrong first impression.

Fix

Rename all five occurrences to identifiabl. The documented config (issuer/audience/jwksUri) already matches IdentifiablConfig, and identifiabl() sets req.user exactly as the surrounding prose describes, so no other changes are needed. Verified the built dist exports identifiabl.

Docs-only; no code or version change.

The README's Basic Usage and later examples imported and called
`createIdentifiablMiddleware`, which the package does not export — the Express
middleware is `identifiabl(config)` (createIdentifiablVerifier is the
non-Express verifier). Copy-pasting the Quick Start failed at the import line.
Rename all five occurrences to the real export; config shape and req.user
usage already match identifiabl()'s behavior, so no other changes needed.
@davidcrowe

Copy link
Copy Markdown
Collaborator Author

Reviewed + confirmed green (MERGEABLE/CLEAN). README Quick Start now uses the real export identifiabl(...) instead of the nonexistent createIdentifiablMiddleware(...) — matches the actual export.

@davidcrowe — needs your merge. No version bump here, so no republish is strictly required; the corrected README will reach npmjs.com on identifiabl's next publish.

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