add readme and license

This commit is contained in:
Jake Walker 2025-05-23 16:46:58 +01:00
parent 71e0022104
commit dc53d31661
No known key found for this signature in database
3 changed files with 29 additions and 1 deletions

View file

@ -1,3 +1,4 @@
{
"deno.enable": true
"deno.enable": true,
"licenser.license": "WTFPL"
}

13
LICENSE Normal file
View file

@ -0,0 +1,13 @@
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2025 Jake Walker
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.

14
README.md Normal file
View file

@ -0,0 +1,14 @@
# Octoplus Coffee Check
[Octopus Energy](https://octopus.energy) give away free coffee to customers each week, but since they started releasing codes every day, rather than at the start of each week, I'm struggling to get them. This is a simple tool that will check for available coffee codes and notify via a webhook.
## Usage
Setup a cronjob to run the script with `deno run -A main.ts`.
The following environment variables are configurable:
- **`OCTOPUS_API_KEY`** - your Octopus Energy API key, [available here](https://octopus.energy/dashboard/new/accounts/personal-details/api-access)
- **`OCTOPUS_ACCOUNT_NUMBER`** - your Octopus Energy account number (like `A-XXXXXXXX`)
- **`WEBHOOK_URL`** - a webhook to your messaging service of choice (e.g. Discord, Slack, etc...)
- _`STATE_FILENAME` - this sets the location of the script's state. By default it'll be `state.json` in the current working directory._