Skip to content

docs: add caching details to README #16

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

Merged
compscidr merged 2 commits into from
Mar 20, 2026
Merged

docs: add caching details to README #16

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1d39d8
docs: add caching details to README
compscidr Mar 20, 2026
a8ef3ac
fix: correct top languages cache TTL in README
compscidr Mar 20, 2026
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
13 changes: 13 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,19 @@ GitHub Action (daily)
└── Writes results to public gist
```

## Caching

Vercel caches card responses to avoid hitting GitHub's API on every request:

| Card | Default | Min | Max |
|------|---------|-----|-----|
| Stats / Overview / Streak / Combined | 24 hours | 12 hours | 48 hours |
| Top Languages | 6 days | 2 days | 10 days |

You can override the default with `&cache_seconds=N` in the URL, but it will be clamped to the min/max range.

After the daily GitHub Action updates the gist, it can take up to 24 hours for the combined card to reflect new data due to Vercel's edge cache. Adding a cache-busting parameter (e.g. `&v=2`) will force a fresh render.

## Debugging

The GitHub Action logs progress per-repo during the daily run, making it easy to identify which repos are slow or hitting API errors. You can also use the debug endpoint:
Expand Down
Loading