Skip to content

Commit ec00d8e

Browse files
authored
Merge pull request #3 from OSSMafia/mnick/fixes
fix: updated readme
2 parents 110594d + 1fd64e8 commit ec00d8e

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

.bumpversion.cfg

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[bumpversion]
2-
current_version = 0.0.2
2+
current_version = 0.0.3
33
commit = True
44
tag = True
55

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33

44
FastAPI Auth Middleware for [Clerk](https://clerk.com)
55

6+
Easily setup authentication on your API routes using your Clerk JWKS endpoint.
7+
68
## Install
79
```bash
8-
pip install fastapi-clerk
10+
pip install fastapi-clerk-auth
911
```
1012

1113
## Basic Usage
@@ -19,9 +21,9 @@ app = FastAPI()
1921

2022
clerk_config = ClerkConfig(jwks_url="https://example.com/.well-known/jwks.json") # Use your Clerk JWKS endpoint
2123

22-
clear_auth_guard = ClerkHTTPBearer(config=clerk_config)
24+
clerk_auth_guard = ClerkHTTPBearer(config=clerk_config)
2325

2426
@app.get("/")
25-
async def read_root(credentials: HTTPAuthorizationCredentials | None = Depends(clear_auth_guard)):
27+
async def read_root(credentials: HTTPAuthorizationCredentials | None = Depends(clerk_auth_guard)):
2628
return JSONResponse(content=jsonable_encoder(credentials))
2729
```

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[project]
22
name = "fastapi_clerk_auth"
3-
version = "0.0.2"
4-
description = "FastAPI Auth Middleware for [Clerk](https://clerk.com)"
3+
version = "0.0.3"
4+
description = "FastAPI Auth Middleware for Clerk (https://clerk.com)"
55
readme = "README.md"
66
requires-python = ">=3.9"
77
authors = [

0 commit comments

Comments
 (0)