Important
我们正为本计划寻找译者。
欢迎你的热情相助。
如果乐意帮忙，请见 #23 议题！
你是早鸟 🐤 还是夜猫 🦉？
白天什么时候最有干劲？
你写的代码是什么语言？
把它们在你的自述文件里展示出来吧！
- 向 markdown（
.md）文件中插入两行注释。可以参考这里的更新方法。 - 你需要一个 WakaTime API 密钥。它可以在 WakaTime 账号设置中获取。
- 如果你第一次用 WakaTime，你可以翻到这里了解更多。
- 如果你要通过 Action 获取 commit 数据，则应当在这里创建 Github 的
repo与userAPI 令牌。- 你可以参考这个示例更好了解这些。
Note
启用 repo 范围虽然看起来很危险，
但是这个 Github Action 只会获取你的 commit 时间戳和你在仓库里改动的代码行数。
- 你需要将 WakaTime API 密钥和 Github API 令牌保存在仓库秘密设置中。
确保你按如下格式保存：
- WakaTime API 密钥，格式为
WAKATIME_API_KEY=<你的 wakatime API 密钥> - Github 个人访问令牌（PAT），格式为
GH_TOKEN=<你的 Github 访问令牌>
- WakaTime API 密钥，格式为
- 根据你的需要显示或隐藏标志。
这个 Github Action 可以通过 cron 表达式设置为任何时间点。见 Crontab.guru 和这个网站生成 cron 表达式。
像这样，把两行注释加入你的 README.md 文件中：
<!--START_SECTION:waka-->
<!--END_SECTION:waka-->waka 可以换成任何 SECTION_NAME 标志中设置的字符串，使得它们可以单独显示可用的标志。
这几行文本就是我们着手添加开发统计的入口。
WakaTime 可以帮你统计出你投身代码的时间长度。这可以帮你提高工作效率，增强竞争优势。
- 前往 https://wakatime.com，创建一个账户。
- 从 WakaTime 账户设置中获取你的 WakaTime API 密钥。
- 在你的编辑器 / 集成开发环境（IDE）中安装 WakaTime 插件。
- 填入你的 API 密钥即可开始分析。
你需要获取 repo 与 user 范围的 Github 访问令牌，在仓库秘密界面以 GH_TOKEN = <你的 Github 访问令牌> 的格式保存。
如下是一份运行用的示例工作流文件：
name: Waka Readme
on:
schedule:
# Runs at 12am IST
- cron: '30 18 * * *'
workflow_dispatch:
jobs:
update-readme:
name: Update Readme with Metrics
runs-on: ubuntu-latest
steps:
- uses: anmol098/waka-readme-stats@master
with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}- 现在你就可以提交 commit，等它自动运行。你也可以手动触发查看结果。只需前往仓库的
Actions部分，选择自述页开发统计工作流，点击Run workflow，等待一两分钟即可看到变化。
如果你想要往统计页面中加入其他信息，可以在工作流文件中加入多个 FLAGS。默认启用所有标志（除了代码改动行数，它对性能有较大影响）。
- uses: anmol098/waka-readme-stats@master
with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
SHOW_OS: "False"
SHOW_PROJECTS: "False"LOCALE 标志可以按你的语言显示统计数据。默认为英语。标志变量中需填入本地化语言键缩写。最终结果示例可以在这里找到。
SCTION_NAME 标志可以设置成任意字符串，是自述文件中替换部分的名称。
COMMIT_BY_ME 标志设置为 True 时会以你的名称与邮箱提交 commit。
COMMIT_MESSAGE 标志可以设置 commit 的附言。默认为“更新开发数据统计（Update with Dev Metrics）”。
COMMIT_USERNAME 标志决定了提交 commit 的用户名称。默认为“readme-bot”。
COMMIT_EMAIL 标志决定了提交 commit 的邮箱地址。默认为“41898282+github-actions[bot]@users.noreply.github.com”。
SHOW_UPDATED_DATE 标志设置为 True 时，展示图表的最后更新日期。
UPDATED_DATE_FORMAT 标志决定了更新日期的格式。默认为 "%d/%m/%Y %H:%M:%S"。
SHOW_LINES_OF_CODE 设置为 True 时，会显示截止今日的代码贡献行数。
SHOW_TOTAL_CODE_TIME 标志设置为 False 时，可隐藏编程时长统计。
SHOW_PROFILE_VIEWS 标志设置为 False 时，可隐藏资料页浏览量统计。
SHOW_COMMIT 标志设置为 False 时，可隐藏提交 commit 统计。
我是早鸟 🐤
🌞 早晨 95 次提交 ███████░░░░░░░░░░░░░░░░░░ 30.55%
🌆 白天 78 次提交 ██████░░░░░░░░░░░░░░░░░░░ 25.08%
🌃 晚上 112 次提交 █████████░░░░░░░░░░░░░░░░ 36.01%
🌙 夜间 26 次提交 ██░░░░░░░░░░░░░░░░░░░░░░░ 8.36%
SHOW_DAYS_OF_WEEK 标志设置为 False 时，可隐藏一周内每日 commit 量情况。
📅 我周日时干劲最足
周一 50 次提交 ███░░░░░░░░░░░░░░░░░░░░░░ 13.19%
周二 85 次提交 █████░░░░░░░░░░░░░░░░░░░░ 22.43%
周三 56 次提交 ███░░░░░░░░░░░░░░░░░░░░░░ 14.78%
周四 44 次提交 ███░░░░░░░░░░░░░░░░░░░░░░ 11.61%
周五 28 次提交 █░░░░░░░░░░░░░░░░░░░░░░░░ 7.39%
周六 30 次提交 ██░░░░░░░░░░░░░░░░░░░░░░░ 7.92%
周日 86 次提交 █████░░░░░░░░░░░░░░░░░░░░ 22.69%
SHOW_LANGUAGE 标志设置为 False 时，可隐藏你的编程语言使用情况。
💬 语言：
JavaScript 5 时 26 分 ███████████████░░░░░░░░░░ 61.97%
PHP 1 时 35 分 ████░░░░░░░░░░░░░░░░░░░░░ 18.07%
Markdown 1 时 9 分 ███░░░░░░░░░░░░░░░░░░░░░░ 13.3%
Python 22 分 █░░░░░░░░░░░░░░░░░░░░░░░░ 4.32%
XML 8 分 ░░░░░░░░░░░░░░░░░░░░░░░░░ 1.62%
SHOW_OS 标志设置为 False 时，可隐藏你的系统使用情况。
💻 操作系统：
Windows 8 时 46 分 █████████████████████████ 100.0%
SHOW_PROJECTS 标志设置为 False 时，可隐藏你正在研究的项目。
🐱💻 项目：
ctx_connector 4 时 3 分 ███████████░░░░░░░░░░░░░░ 46.33%
NetSuite-Connector 1 时 31 分 ████░░░░░░░░░░░░░░░░░░░░░ 17.29%
mango-web-master 1 时 12 分 ███░░░░░░░░░░░░░░░░░░░░░░ 13.77%
cable 54 分 ██░░░░░░░░░░░░░░░░░░░░░░░ 10.41%
denAPI 40 分 ██░░░░░░░░░░░░░░░░░░░░░░░ 7.66%
SHOW_TIMEZONE 标志设置为 False 时，可隐藏你所处的时区。
⌚︎ 时区：Asia/Calcutta
SHOW_EDITORS 标志设置为 False 时，可隐藏编辑器/集成开发环境（IDE）的使用情况。
🔥 编辑器：
WebStorm 6 时 47 分 ███████████████████░░░░░░ 77.43%
PhpStorm 1 时 35 分 ████░░░░░░░░░░░░░░░░░░░░░ 18.07%
PyCharm 23 分 █░░░░░░░░░░░░░░░░░░░░░░░░ 4.49%
SHOW_LANGUAGE_PER_REPO 标志设置为 False 时，可隐藏不同编程语言与框架在各个仓库中的占比显示。
我更常编写 Vue 代码
Vue 8 个仓库 ██████░░░░░░░░░░░░░░░░░░░ 25.0%
Java 6 个仓库 ████░░░░░░░░░░░░░░░░░░░░░ 18.75%
JavaScript 6 个仓库 ████░░░░░░░░░░░░░░░░░░░░░ 18.75%
PHP 3 个仓库 ██░░░░░░░░░░░░░░░░░░░░░░░ 9.38%
Python 2 个仓库 █░░░░░░░░░░░░░░░░░░░░░░░░ 6.25%
Dart 2 个仓库 █░░░░░░░░░░░░░░░░░░░░░░░░ 6.25%
CSS 2 个仓库 █░░░░░░░░░░░░░░░░░░░░░░░░ 6.25%
SHOW_SHORT_INFO 标志设置为 False 时可以隐藏用户的概述信息。
Note
该部分需要 user 范围的个人访问令牌（PAT），否则这里的数据不会正确显示。
🐱 我的 Github 数据
🏆 在 2020 年贡献了 433 次
📦 使用了 292.3 kB GitHub 存储空间
💼 开放招聘
📜 25 个公开仓库
🔑 15 个私有仓库
SHOW_LOC_CHART 标志设置为 False 时，会隐藏不同年份不同季度的代码贡献行数。
IGNORED_REPO 标志可以设置为 "waka-readme-stats, my-first-repo"（仅为示例），去除你不想计入的仓库。
如果你用诸如 wakapi 等服务器自托管了兼容 wakatime 的服务，你可以设置 WAKATIME_API_URL 标志进行 API 对接。只需将链接按这样的格式填写即可： https://your-own-wakapi.dev/api/。
SYMBOL_VERSION 标志可以改变进度条的样式（默认为 1）。
| 版本 | 填充格 | 空格 |
|---|---|---|
| 1 | █ | ░ |
| 2 | ⣿ | ⣀ |
| 3 | ⬛ | ⬜ |
DEBUG_LOGGING 标志可以让 Github Action 的日志更长，默认情况下与内部运行调试设置同步。
BADGE_STYLE 标志决定了生成徽章的样式，可以设置为 flat, flat-square、plastic、for-the-badge 或者 social。
| 徽章样式 | 预览 |
|---|---|
flat |
 |
flat-square |
 |
plastic |
 |
for-the-badge |
 |
social |
 |
时间线
我尽可能开源我所创造的代码，并积极回复那些使用本项目时遇到问题的网友。 这得花上不少时间。享受这样的服务不用花一分钱。
如果你正在使用这个项目，觉得开心或想鼓励我创造更多好东西，你可以这样帮我：——
- 在你的自述文件上使用这个 Action，附上合适的署名，并贴上相关链接 :D
- 点亮星星，分享项目 🚀
- 你可以用 PayPal 进行单次捐赠。我会用它买点
靓啤红酒 🍷 的。
谢谢！:heart:
欢迎你的贡献 ♥!
想到了什么新功能，或者想帮助我们进行测试？可以通过拉取请求和议题功帮我们把项目变得更好。
- Anmol Pratap Singh：维护者
- Alexander Sergeev：维护者
- DataBoySu：维护者
- okcoder1：维护者
- Aravind V. Nair：维护者
- Prabhat Singh：贡献了代码时间线图表 #18
- Hedy Li：贡献了合并请求 #34 and #23
- Pedro Torres：贡献了合并请求 #29
- Aaron Meese：贡献了合并请求 #45
- Arnav Jindal：贡献了合并请求 #48
- Daniel Rowe：贡献了合并请求 #57
- Ss5h：添加了自然语言文本的翻译支持 #136
特别鸣谢这些装点了他们的资料页的用户们 😄 🎉
- 你也是！如果你正在使用它且未上榜，可以通过特殊提及议题告诉我！:blush:
我们很乐意让你上榜。
以 ❤️ 与 Python 🐍 制作。
