modulepackage
1.2.1
Repository: https://github.com/nickrtr/wakatime-readme.git
Documentation: pkg.go.dev
# README
WakaTime-Readme
Go GitHub Action that adds Coding time statistics to your README
Last 7 Days
Svelte 5 hrs 48 mins 🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨🟨⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 49.64 %
TypeScript 2 hrs 38 mins 🟨🟨🟨🟨🟨⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 22.58 %
Go 1 hr 44 mins 🟨🟨🟨⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 14.94 %
JavaScript 55 mins 🟨🟨⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 7.84 %
JSON 11 mins ⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜ 1.68 %All Time
Total Time Coded: 543 hrs 42 mins
Timespan: 407 days
Daily average: 1 hr(s) 19 min(s)
Documentation
- Update the markdown file with 2 comments:
<!--WakaTime-Start-->
and<!--WakaTime-End-->
- Get your WakaTime API Key (https://wakatime.com/settings/account)
- Generate a GitHub API Token with repo and user scope (https://github.com/settings/tokens)
- Store the WakaTime API Key and GitHub access token in your repository's action secrets as following:
- WakaTime API Key:
WAKATIME_API_KEY=<your key>
- GitHub Token:
GH_TOKEN=<your GitHub access token>
- WakaTime API Key:
- Create a new GitHub Action in the Repository, you want the Readme stats in:
name: WakaTime Readme
on:
schedule:
- cron: "0 1 * * *"
workflow_dispatch:
env:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
THEME: "default"
jobs:
WakaTime-README:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: NickRTR/[email protected]
- Wait for the action to run automatically every night or run it manually for testing purposes.
- Let the magic happen 🚀
Themes
There are a number of different themes, you can choose from.
Theme | env variable |
---|---|
â–‘â–ˆ | default |
------ | -------------- |
⬜🟩 | block-green |
⬜🟨 | block-yellow |
⬜🟥 | block-red |
⬜🟪 | block-purple |
⬜🟧 | block-orange |
⬜🟦 | block-blue |
⬜⬛ | block-black |
------ | -------------- |
⚪🟢 | circle-green |
⚪🟡 | circle-yellow |
⚪🔴 | circle-red |
⚪🟣 | circle-purple |
⚪🟠| circle-orange |
⚪🔵 | circle-blue |
⚪⚫ | circle-black |
Specify a theme by adding THEME: <theme>
to the env variables of your workflow yaml file.
If no theme is specified, the default is selected.