Skip to content

Commit c1e4062

Browse files
committed
Prepare v2.4.0 release
1 parent 7fe8f2d commit c1e4062

6 files changed

Lines changed: 51 additions & 23 deletions

File tree

.claude-plugin/plugin.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "readme-skill",
33
"description": "Generate an AI-Native developer profile from local Claude Code + Codex data, GitHub contributions, and git log. Local-only, read-only, anonymized by default.",
4-
"version": "2.0.0",
4+
"version": "2.4.0",
55
"author": {
66
"name": "JingWen Fan",
77
"url": "https://github.com/study8677"

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
output/*.md
1+
output/*
22
!output/.gitkeep

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 JingWen Fan
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.en.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Readme.skill is not a program — it's an instruction set for an AI agent (i.e.
2525
2. Call `gh` to pull your GitHub public contribution calendar and top repos
2626
3. Run read-only `git log` in your working directories to count local commits
2727
4. Compute 10 dimensions (overview / AI-Native / collaboration style / projects / topics / rhythm / output × input / velocity / evolution / token economics)
28-
5. Anonymize and redact by default; write to `output/profile_YYYYMMDD.md`
28+
5. Anonymize and redact by default; write in the requested language to `output/profile_YYYYMMDD.md` or `output/profile_YYYYMMDD_en.md`
2929

3030
The whole flow is **read-only and fully local (except `gh`)** — safe to run, safe to share. Conversation text may be read for keyword and collaboration-style signal, but never copied verbatim into the report.
3131

@@ -91,7 +91,7 @@ After installing, say one of these in Claude Code or Codex:
9191
- "generate my AI profile" / "生成我的 AI 档案"
9292
- "analyze my Claude usage"
9393

94-
The AI runs the full pipeline and writes to `output/profile_<date>.md`.
94+
The AI runs the full pipeline and writes to `output/profile_<date>_en.md` for English requests, or `output/profile_<date>.md` for Chinese/default requests.
9595

9696
### Private vs shareable
9797

@@ -177,7 +177,7 @@ Design principles (from the v2.4 brief): identity readable in 3 seconds + 6 evid
177177

178178
## License
179179

180-
MIT
180+
[MIT](./LICENSE)
181181

182182
## Friends
183183

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ Readme.skill 不是一个程序,而是一份给 AI agent 的指令集(即 [`
2424
1. 读取本机 `~/.claude/``~/.codex/` 的统计文件、SQLite、历史 JSONL
2525
2. 调用 `gh` 拉取你的 GitHub 公开贡献日历与 top 仓库
2626
3. 在你的工作目录里跑只读 `git log`,统计本地提交
27-
4. 计算 7 个维度(一览 / AI-Native / 协作风格 / 项目 / 主题 / 节奏 / 投入×产出)
28-
5. 默认匿名脱敏,输出 `output/profile_YYYYMMDD.md`
27+
4. 计算 10 个维度(一览 / AI-Native / 基础设施 / 协作风格 / 项目 / 主题 / 节奏 / Token 经济学 / 投入×产出 / 进化曲线
28+
5. 默认匿名脱敏,按提问语言输出 `output/profile_YYYYMMDD.md``output/profile_YYYYMMDD_en.md`
2929

3030
整个过程**只读、不联网(除 `gh`**,可放心运行并对外分享结果。对话正文可被读取以提取关键词和协作风格信号,但原文不会写进报告。
3131

@@ -91,7 +91,7 @@ mkdir -p ~/.codex/skills/readme-skill && curl -fsSL https://raw.githubuserconten
9191
- "build my AI usage profile"
9292
- "summarize my Claude / Codex history"
9393

94-
AI 会跑完整套流程,把结果写到 `output/profile_<日期>.md`
94+
AI 会跑完整套流程,把结果写到 `output/profile_<日期>.md`如果你用英文提问或明确要求英文版,会写到 `output/profile_<日期>_en.md`
9595

9696
### 私人版 vs 分享版
9797

@@ -177,7 +177,7 @@ chromium --headless --screenshot=poster.png --window-size=1080,1920 output/poste
177177

178178
## 协议
179179

180-
MIT
180+
[MIT](./LICENSE)
181181

182182
## 友链
183183

skills/readme-skill/SKILL.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ license: MIT
1414
# Readme.skill — AI-Native 开发者档案生成器
1515

1616
You (the AI agent invoking this skill) will read local Claude Code + Codex data,
17-
compute a fixed set of dimensions, and render a Chinese Markdown profile under
18-
`./output/`. **You do all of the work** — read the files with `Read`, query
19-
sqlite via `Bash`, and synthesize the prose yourself. Do **not** write helper
20-
scripts; the skill is the recipe.
17+
compute a fixed set of dimensions, and render a Markdown profile under
18+
`./output/` in the user's requested language (Chinese by default; English when
19+
the user asks in English or explicitly requests English). **You do all of the
20+
work** — read the files with `Read`, query sqlite via `Bash`, and synthesize the
21+
prose yourself. Do **not** write helper scripts; the skill is the recipe.
2122

2223
> 默认行为:**对外分享版** —— 项目名匿名、敏感信息脱敏。
2324
> 如果用户明确说"私人版 / 不要脱敏 / show real names",跳过匿名步骤。
@@ -511,9 +512,15 @@ If user said "show real names" / "私人版":
511512

512513
## Step 8 — 渲染最终 Markdown
513514

514-
Write to `output/profile_<YYYYMMDD>.md` using **exactly** this structure
515-
(中文叙事 + 表格;技术词保留英文;**讲故事优先于堆数据**
516-
展示「因为 AI 而不同」,而不仅仅是「用了很多 AI」):
515+
Choose the profile language before writing:
516+
- 用户用中文问或未指定语言 → `output/profile_<YYYYMMDD>.md`,使用中文叙事
517+
- 用户用英文问或明确要求 English / EN → `output/profile_<YYYYMMDD>_en.md`,使用英文叙事
518+
- 用户要求 both / bilingual / 两个都要 → 两份都生成
519+
520+
Use **exactly** this structure. For English output, translate headings and prose
521+
to English following `examples/profile_20260508_en.md`; for Chinese output, use
522+
the structure below. Technical terms stay in English in both versions. **讲故事优先于堆数据**
523+
展示「因为 AI 而不同」,而不仅仅是「用了很多 AI」:
517524

518525
```markdown
519526
# <name or github_login> · AI-Native Developer Profile
@@ -709,7 +716,7 @@ xhigh **<n>**(**<%>**)· high **<n>** · medium **<n>** · low **<n>**
709716

710717
## Step 8b — 海报渲染(v2.4 新增 · 可选)
711718

712-
如果用户说"生成海报" / "AI 海报" / "social card" / "可分享图" / "make poster",或默认就把它当一份附加交付物,在 markdown profile 完成后再渲染一份 SVG 海报到 `output/poster_<YYYYMMDD>.svg`
719+
如果用户说"生成海报" / "AI 海报" / "social card" / "可分享图" / "make poster",或默认就把它当一份附加交付物,在 markdown profile 完成后再渲染 SVG 海报到 `output/poster_<YYYYMMDD>_<lang>.svg`(例如 `_zh.svg` / `_en.svg`
713720

714721
### 设计原则(来自 v2.4 brief,由 Codex 审校)
715722

@@ -873,16 +880,16 @@ xhigh **<n>**(**<%>**)· high **<n>** · medium **<n>** · low **<n>**
873880

874881
## Step 9 — 输出与交接
875882

876-
把 Markdown 写入 `output/profile_<YYYYMMDD>.md`
883+
把 Markdown 写入对应语言的 `output/profile_<YYYYMMDD>.md``output/profile_<YYYYMMDD>_en.md`
877884
然后给用户**一句话**总结:
878885

879886
```
880-
✅ Profile generated: output/profile_<YYYYMMDD>.md
881-
🎨 Poster: output/poster_<YYYYMMDD>.svg (如果生成了)
887+
✅ Profile generated: output/profile_<YYYYMMDD>.md (或 output/profile_<YYYYMMDD>_en.md)
888+
🎨 Poster: output/poster_<YYYYMMDD>_<lang>.svg (如果生成了)
882889
关键数字:<sessions> sessions / <tokens> tokens / <github_commits> commits
883-
预览:head -40 output/profile_<YYYYMMDD>.md
884-
预览海报:open output/poster_<YYYYMMDD>.svg
885-
转 PNG:rsvg-convert -h 1920 output/poster_<YYYYMMDD>.svg > poster.png
890+
预览:head -40 <profile_path>
891+
预览海报:open output/poster_<YYYYMMDD>_<lang>.svg
892+
转 PNG:rsvg-convert -h 1920 output/poster_<YYYYMMDD>_<lang>.svg > poster.png
886893
(或 chromium --headless --screenshot=poster.png poster.svg)
887894
```
888895

0 commit comments

Comments
 (0)