Skip to content

Commit fa904af

Browse files
add api key instructions to readme and update deployment workflow
1 parent 5c8f90d commit fa904af

File tree

2 files changed

+11
-3
lines changed

2 files changed

+11
-3
lines changed

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ jobs:
5757

5858
- name: Check package
5959
run: |
60-
uv pip install twine
61-
uv run twine check dist/*
60+
uv tool install twine
61+
uv tool run twine check dist/*
6262
6363
- name: Upload artifacts
6464
uses: actions/upload-artifact@v4

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,14 @@ asyncio.run(main())
4141

4242
## Authentication
4343

44+
### Getting an API Key
45+
46+
1. Visit https://api.rencom.ai/login
47+
2. Sign in with your email, Github or Google
48+
3. Generate an API key from your dashboard
49+
50+
### Using Your API Key
51+
4452
The SDK supports multiple authentication methods:
4553

4654
**API Key** (recommended):
@@ -72,7 +80,7 @@ client = AsyncRencomClient(jwt_token="eyJ...")
7280

7381
## Documentation
7482

75-
Full documentation is available at https://rencom-sdk-python.readthedocs.io
83+
Full documentation coming soon.
7684

7785
See the [examples/](./examples) directory for more usage examples.
7886

0 commit comments

Comments
 (0)