Bennett/snk
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📓 update readme

Browse Source
This commit is contained in:
platane
2023-07-17 22:48:32 +02:00
committed by Platane
parent ebeb59fced
commit 1574f65738
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -35,7 +35,7 @@ Available as github action. It can automatically generate a new image each day.
**github action** **github action**
```yaml ```yaml
- uses: Platane/snk@v2 - uses: Platane/snk@v3
with: with:
# github user name to read the contribution graph from (**required**) # github user name to read the contribution graph from (**required**)
# using action context var `github.repository_owner` or specified user # using action context var `github.repository_owner` or specified user
@@ -54,6 +54,10 @@ Available as github action. It can automatically generate a new image each day.
dist/github-snake.svg dist/github-snake.svg
dist/github-snake-dark.svg?palette=github-dark dist/github-snake-dark.svg?palette=github-dark
dist/ocean.gif?color_snake=orange&color_dots=#bfd6f6,#8dbdff,#64a1f4,#4b91f1,#3c7dd9 dist/ocean.gif?color_snake=orange&color_dots=#bfd6f6,#8dbdff,#64a1f4,#4b91f1,#3c7dd9
env:
# a github token is required to fetch the contribution calendar from github API
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
``` ```
[example with cron job](https://github.com/Platane/Platane/blob/master/.github/workflows/main.yml#L24-L29) [example with cron job](https://github.com/Platane/Platane/blob/master/.github/workflows/main.yml#L24-L29)