commit cd23c8e3502454d0a1e5246b4b2ddb8974922b42
parent 34badf17eb5353e0103f046b4ffe19d8fcf60817
Author: Emily Doherty <git@emily.sh>
Date: Sun, 8 Dec 2024 18:10:01 -0800
Install pre-commit hooks
Diffstat:
2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
@@ -1,3 +1,15 @@
# wow-token-app-bot
-An interactions.py Discord bot for getting and alerting on the WoW Token Price
-\ No newline at end of file
+An interactions.py Discord bot for getting and alerting on the WoW Token Price
+
+
+# Help
+If you are a user of this bot and are looking for help on how to use it, you can find a small tutorial [here](https://blog.emily.sh/token-bot/)
+
+
+# Contributing
+1. Clone the project
+2. Install the requirements `pip install -r requirements.txt`
+3. Install pre-commit hooks `pre-commit install`
+4. To run this application you will need to have created DynamoDB tables and have a discord app token to use
+ - You will need to specify at least ALERTS_TABLE, USERS_TABLE, DISCORD_TOKEN, and AWS_REGION
diff --git a/requirements.txt b/requirements.txt
@@ -15,6 +15,7 @@ httpcore==1.0.5
httpx==0.27.0
idna==3.7
multidict==6.0.5
+pre-commit==4.0.1
python-dateutil==2.9.0.post0
python-dotenv==1.0.1
pytz==2024.1
