advent-of-code/leaderboard-scanner
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add daemonize mode, readme

Browse Source
This commit is contained in:
Chris Pickett
2023-12-03 19:18:26 -06:00
parent c250828dbe
commit 6eadef654f
3 changed files with 32 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# Advent of Code leaderboard tracker for Mattermost
## Summary
This is an application designed to be run on some sort of cron-like schedule or on its own with the `-d` argument where it will scan every 15 minutes. It will check the status of an [Advent of Code](https://adventofcode.com) leaderboard and report any diffs to the given Mattermost webhook.
## Configurables
The following configurables are supported in either argument ("-arg=val"), environment, or [.env](https://github.com/joho/godotenv) file form:
Argument | Env var | Description | Default
---- | ---- | ---- | ----
year | (none) | The event year to scan | "2023"
leaderboard | AOC_LEADERBOARD | The leaderboard ID to read (e.g. 1234567) | ""
session | AOC_SESSION | A valid session ID pulled from your web browser on a logged-in account | ""
webhookURL | AOC_WEBHOOK | The full URL for an incoming webhook to your Mattermost instance (e.g. https://my.mattermost.server/hooks/abcd1234) | ""
d | (none) | Daemonize the application so it refreshes itself every 15 minutes | false