Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davidcrowe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions packages/identifiabl/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ npm install @gatewaystack/identifiabl

```typescript
import express from 'express';
import { createIdentifiablMiddleware } from '@gatewaystack/identifiabl';
import { identifiabl } from '@gatewaystack/identifiabl';

const app = express();

// Add identity verification to all routes
app.use(createIdentifiablMiddleware({
app.use(identifiabl({
issuer: 'https://your-tenant.auth0.com/',
audience: 'https://gateway.local/api',
jwksUri: 'https://your-tenant.auth0.com/.well-known/jwks.json'
Expand All @@ -59,7 +59,7 @@ app.get('/api/data', (req, res) => {
app.get('/health', (req, res) => res.json({ ok: true }));

// Protected routes (auth required)
app.use('/protected', createIdentifiablMiddleware({
app.use('/protected', identifiabl({
issuer: process.env.OAUTH_ISSUER,
audience: process.env.OAUTH_AUDIENCE,
jwksUri: process.env.OAUTH_JWKS_URI
Expand Down Expand Up @@ -400,7 +400,7 @@ identifiabl is optimized for production:
### Custom Claims Extraction

```typescript
app.use(createIdentifiablMiddleware({
app.use(identifiabl({
issuer: process.env.OAUTH_ISSUER,
audience: process.env.OAUTH_AUDIENCE,
jwksUri: process.env.OAUTH_JWKS_URI,
Expand All @@ -418,7 +418,7 @@ app.use(createIdentifiablMiddleware({

```typescript
// Enforce tenant ID in token
app.use(createIdentifiablMiddleware({
app.use(identifiabl({
issuer: process.env.OAUTH_ISSUER,
audience: process.env.OAUTH_AUDIENCE,
jwksUri: process.env.OAUTH_JWKS_URI,
Expand Down
Loading