Skip to content

Commit 1574f65

Browse files
committed
📓 update readme
1 parent ebeb59f commit 1574f65

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

‎README.md‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Available as github action. It can automatically generate a new image each day.
3535
**github action**
3636

3737
```yaml
38-
- uses: Platane/snk@v2
38+
- uses: Platane/snk@v3
3939
with:
4040
# github user name to read the contribution graph from (**required**)
4141
# 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.
5454
dist/github-snake.svg
5555
dist/github-snake-dark.svg?palette=github-dark
5656
dist/ocean.gif?color_snake=orange&color_dots=#bfd6f6,#8dbdff,#64a1f4,#4b91f1,#3c7dd9
57+
58+
env:
59+
# a github token is required to fetch the contribution calendar from github API
60+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5761
```
5862
5963
[example with cron job](https://github.com/Platane/Platane/blob/master/.github/workflows/main.yml#L24-L29)

0 commit comments

Comments
 (0)