Files
waka-box/README.md
Matan Kushner e68b9bb3e6 Clean up docs
2019-04-06 18:22:49 -04:00

31 lines
1.2 KiB
Markdown

<p align="center">
<img width="400" src="https://user-images.githubusercontent.com/4658208/54497463-4be25680-48d1-11e9-9f84-1ca605ae100f.png">
<h3 align="center">waka-box</h3>
<p align="center">Update a pinned gist to contain your weekly WakaTime stats</p>
</p>
---
> 📌✨ For more pinned-gist projects like this one, check out: https://github.com/matchai/awesome-pinned-gists
## Setup
### Prep work
1. Create a new public GitHub Gist (https://gist.github.com/)
1. Create a token with the `gist` scope and copy it. (https://github.com/settings/tokens/new)
1. Create a WakaTime account (https://wakatime.com/signup)
1. In your account settings, copy the existing WakaTime API Key (https://wakatime.com/settings/account)
### Project setup
1. Fork this repo
1. Edit the [environment variable](https://github.com/matchai/bird-box/blob/master/.github/main.workflow?short_path=5225be4#L9-L10) in `.github/main.workflow`:
- **GIST_ID:** The ID portion from your gist url: `https://gist.github.com/matchai/`**`6d5f84419863089a167387da62dd7081`**.
1. Go to the repo **Settings > Secrets**
1. Add the following environment variables:
- **GH_TOKEN:** The GitHub token generated above.
- **WAKATIME_API_KEY:** The API key for your WakaTime account.