Skip to content

Commit 56ce38e

Browse files
committed
docs: update README to reposition screenshot section and clarify cache usage
1 parent b9d5408 commit 56ce38e

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,6 @@ CLI that computes **per-author** GitHub language statistics by inspecting the fi
44

55
Unlike `GET /repos/{owner}/{repo}/languages` (which returns repo-wide bytes regardless of who wrote them), this tool only counts lines in files **you personally changed**.
66

7-
## Screenshot
8-
9-
Example of how the output data can be visualized — this chart is from the IndieCV app by smallstack, built on top of the JSON data this tool produces:
10-
11-
[![github-lang-stats screenshot](https://wsrv.nl/?url=https://ltmdiiguvlmrsihp.public.blob.vercel-storage.com/screenshots/github-lang-stats-wide.png&h=300)](https://ltmdiiguvlmrsihp.public.blob.vercel-storage.com/screenshots/github-lang-stats-wide.png)
12-
13-
147
## Why use this instead of your GitHub profile?
158

169
GitHub's default profile has two major limitations:
@@ -39,6 +32,11 @@ Perfect for portfolios, resumes, and demonstrating your real technical expertise
3932

4033
Progress is cached in `.github-lang-stats-cache/<user>.json` so **interrupted runs resume from where they left off**.
4134

35+
> **⚠️ Former employer / removed from org?**
36+
> Phase 3 requires **current read access** to each repository. If you've since been removed from a private org or repo, those `GET /commits/:sha` calls will return `404` and no language stats will be collected for that work.
37+
>
38+
> **Workaround:** Run the tool while you still have access and keep the cache file. On future runs the tool will use cached data, so your stats remain intact even after access is revoked.
39+
4240
**Note**: PR counts are collected by default starting with Phase 4. Use `--exclude-pr-counts` to skip this phase if you don't need PR data. The Search API has a stricter rate limit (30 requests/minute), so PR collection includes automatic 2-second delays between requests.
4341

4442
## Metric: `lines_changed`
@@ -247,6 +245,12 @@ When `--exclude-pr-counts` is used, the metadata includes `"excludedPRs": true`.
247245
- **Exclude infrastructure languages** with `--exclude-langs HCL,Dockerfile` if teammates committed those to repos you also touched.
248246
- **Adjust concurrency** carefully — GitHub's [secondary rate limits](https://docs.github.com/en/rest/using-the-rest-api/rate-limits-for-the-rest-api) may trigger at high concurrency even if your primary limit is not exhausted. `5` is a safe default.
249247

248+
## Screenshot
249+
250+
Example of how the output data can be visualized — this chart is from the IndieCV app by smallstack, built on top of the JSON data this tool produces:
251+
252+
[![github-lang-stats screenshot](https://wsrv.nl/?url=https://ltmdiiguvlmrsihp.public.blob.vercel-storage.com/screenshots/github-lang-stats-wide.png&h=300)](https://ltmdiiguvlmrsihp.public.blob.vercel-storage.com/screenshots/github-lang-stats-wide.png)
253+
250254
---
251255

252256
Made by [smallstack GmbH](https://smallstack.com) · [GitHub](https://github.com/smallstack/github-lang-stats) · [npm](https://www.npmjs.com/package/github-lang-stats)

0 commit comments

Comments
 (0)