From 544796e0ca900f1ef32e254fbe2dd22fc1f8c104 Mon Sep 17 00:00:00 2001
From: agatha <agatha@juggalol.com>
Date: Sun, 3 Dec 2023 12:19:26 -0500
Subject: [PATCH] Add usage instructions

---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 93b242c..44c1dc1 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
 # stockbot-buyvm
-Send alerts when [BuyVM](https://buyvm.net) has KVM slices in stock.
\ No newline at end of file
+Send alerts when [BuyVM](https://buyvm.net) has KVM slices in stock.
+
+## Usage
+1. Create a Discord Webhook and add it to `config.py`:
+```python
+DISCORD_WEBHOOK = '<discord webhook url>'
+```
+
+2. Build Docker container:
+```shell
+docker build -t stockbot-buyvm .
+```
+
+3. Run with a cronjob and optionally capture logs:
+```
+*/10 * * * * docker run --rm stockbot-buyvm >> /home/user/.local/logs/stockbot-buyvm.log 2>&1
+```
\ No newline at end of file