Skip to content

Commit 8662f2f

Browse files
committed
📝 Updated readme
1 parent d463317 commit 8662f2f

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Send a webhook notification when someone from an Advent Of Code leaderboard solv
44

55
I'm using this to track the progress of a group of friends on Discord.
66

7+
![Message example](https://user-images.githubusercontent.com/5692603/100946056-738cae80-34fa-11eb-833f-645b8ea2e116.png)
8+
79
## Usage
810

911
Just run this image periodically (at a minimum interval of 15 min):
@@ -18,6 +20,16 @@ $ docker run \
1820
ghcr.io/tofran/advent-of-code-leaderboard-notifier
1921
```
2022

23+
### Configuration
24+
25+
- `ADVENT_OF_CODE_LEADERBOARD_ID`: The unique ID of the leaderboard. It's an integer you can get from the end of leaderboard url or the prefix of the invite code.
26+
- `ADVENT_OF_CODE_SESSION_ID`: Your advent of code session id.
27+
To retrieve it, go visit adventofcode.com, open developer tools > storage > cookies > copy the value of your `session` cookie.
28+
- `WEBHOOK_URL`: Where to send the webhook. Can be for example a discord webhook.
29+
- `ADVENT_OF_CODE_YEAR`: Optional, defaults to `2020`
30+
- `CACHE_FILE`: Optional, defaults to `./cache.json`
31+
32+
2133
## License
2234

2335
MIT

0 commit comments

Comments
 (0)