Skip to content

Commit dee7679

Browse files
committed
docs(development): add GitHub API authentication instructions to avoid rate limiting
1 parent f9bafc2 commit dee7679

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

doc/internals/development.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,25 @@ The project maintains synchronization with:
130130
- Node.js SQLite implementation
131131
- SQLite amalgamation source
132132

133+
### GitHub API Authentication
134+
135+
To avoid rate limiting when syncing from GitHub (60 requests/hour for unauthenticated requests), set up authentication:
136+
137+
```bash
138+
# Set your GitHub personal access token
139+
export GITHUB_TOKEN=your_personal_access_token
140+
141+
# Now sync commands will use authentication (5000 requests/hour)
142+
npm run sync:node
143+
npm run sync:sqlite
144+
```
145+
146+
You can create a personal access token at: https://github.com/settings/tokens
147+
148+
The token only needs public repository read access.
149+
150+
### Sync Commands
151+
133152
```bash
134153
# Sync from Node.js
135154
npm run sync:node

0 commit comments

Comments
 (0)