Skip to content

Commit d463317

Browse files
committed
📝 Added readme
1 parent 2f16ae9 commit d463317

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Advent of code leaderboard notifier
2+
3+
Send a webhook notification when someone from an Advent Of Code leaderboard solves a puzzle
4+
5+
I'm using this to track the progress of a group of friends on Discord.
6+
7+
## Usage
8+
9+
Just run this image periodically (at a minimum interval of 15 min):
10+
11+
```sh
12+
$ docker run \
13+
-e WEBHOOK_URL="your webhook url" \
14+
-e ADVENT_OF_CODE_SESSION_ID="your advent of code session id" \
15+
-e ADVENT_OF_CODE_LEADERBOARD_ID="numeric leaderboard id" \
16+
-e CACHE_FILE=/cache/cache.json \
17+
-v "$(pwd)/cache/:/cache/" \
18+
ghcr.io/tofran/advent-of-code-leaderboard-notifier
19+
```
20+
21+
## License
22+
23+
MIT

0 commit comments

Comments
 (0)