GitHub Action
MonkeyType Stats - Readme
Show / hide
Style variants: show / hide
| style | demo |
|---|---|
| flat |  |
| flat-square |  |
| plastic |  |
| for-the-badge |  |
Icon variant: show / hide
| icon | demo |
|---|---|
| one | |
| two |  |
Show / hide
This project's strategy relies on shields.io endpoint api. For one time & static badge, follow the steps below.
-
Edit this endpoint to your liking:
https://monkeytype-badge-vhd5lan7mmhz.runkit.sh?message=...&label=...&logoVarient=...See Endpoint Documentation for more details about the query params.
-
Parse (1) and use shields.io endpoint helper to further customize your badge.
Show / hide
Put the following at the bottom of your README. This is a default badge that will get updated by the github action...
[monkeytype.badge]: https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fmonkeytype-badge-vhd5lan7mmhz.runkit.shYou can display this badge somewhere in your readme as below, which will render similar to those in the Demo section.
<!-- For just the image -->
![!monkeytype.badge]
<!-- For clickable image that links to monkeytype website -->
[![monkeytype.badge]](https://monkeytype.com/)Go to monkeytype.settings, search for the ape key section, then generate and save an API Key somewhere for the next step
Add this key as a Action secret in your repo's settings.
Now follow the next section to set up a github workflow.
See action.yaml for description about the inputs.
I recommend keeping the workflow_dispatch trigger so you can run the action manually whenever you want.
Since personal bests don't change that often, in the example I leave it to run once every week. But you can use the crontab-guru site to adjust as needed.
Example: show / hide
# .github/workflow/monkeytype.yaml
name: Monkeytype Readme
on:
# Runs if triggered manually through github action console
workflow_dispatch:
schedule:
# Runs at 00:00 each sunday
- cron: '0 0 * * 0'
jobs:
update-readme:
name: Update this repo's README
runs-on: ubuntu-latest
steps:
- uses: vnphanquang/monkeytype-readme@main
with:
# required:
monkeytype_api_key: ${{ secrets.MONKEYTYPE_API_KEY }}
mode: 'time'
mode2: '30'
# not required with default:
style: 'flat'
logoVariant: 'one'
label: 'monkeytype'
# outputs badge_url should you need to use that in later stepsSee the code on runkit. The endpoint is:
https://monkeytype-badge-vhd5lan7mmhz.runkit.sh
Query params: show / hide
| name | required | default | description |
|---|---|---|---|
message |
no | calculating |
message to display on the badge, usually something like '120wpm' |
logoVariant |
no | one |
the logo variant to use, see Demo. Accepts only the string one or two |
label |
no | monkeytype |
the text next to the icon |
