imbios/waka-readme-stats

imbios/waka-readme-stats镜像说明

镜像概述

imbios/waka-readme-stats镜像用于动态生成开发统计数据，并自动更新到GitHub README文件中，帮助开发者展示其编码活动和项目贡献情况。该镜像支持多种统计维度，可通过配置项自定义展示内容。

核心功能

• 展示编码时间统计（总时长、时段分布）
• 编程语言使用分布
• 提交记录时间分布（早中晚、星期几）
• 操作系统、编辑器使用情况
• 参与项目统计
• 代码行数统计
• 个人GitHub数据概览（贡献数、仓库数等）

使用场景

• 个人GitHub主页展示编码活动数据
• 开源项目README添加开发指标
• 团队成员展示个人贡献情况

配置说明

准备工作

1. 获取WakaTime API Key：从WakaTime账户设置获取。
2. 获取GitHub Token：需包含repo和user权限，从https://github.com/settings/tokens%E7%94%9F%E6%88%90%E3%80%82
3. 将上述密钥保存到GitHub仓库Secrets中，分别命名为WAKATIME_API_KEY和GH_TOKEN。

更新README

在README.md中添加以下注释作为统计数据的插入点：

markdown
<!--START_SECTION:waka-->
<!--END_SECTION:waka-->

GitHub Action配置示例

创建.github/workflows/waka-readme.yml文件：

yaml
name: Waka Readme Stats
on:
  schedule:
    - cron: '30 18 * * *' # 每天00:00 IST（北京时间05:30）
  workflow_dispatch:
jobs:
  update-readme:
    runs-on: ubuntu-latest
    steps:
      - uses: imbios/waka-readme-stats@master
        with:
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
          GH_TOKEN: ${{ secrets.GH_TOKEN }}
          # 可选配置（默认全部开启）
          SHOW_OS: "False"
          SHOW_PROJECTS: "False"
          SHOW_LINES_OF_CODE: "True"

常用配置项

• LOCALE：设置语言（如zh-CN）
• SECTION_NAME：自定义README中的插入段名称
• SHOW_COMMIT：是否展示提交分布（默认True）
• SHOW_LANGUAGE：是否展示语言分布（默认True）
• IGNORED_REPOS：忽略统计的仓库列表（逗号分隔）

通过上述配置，镜像将自动定期更新README中的统计数据，展示开发者的编码活动情况。 ===END===