From e1e92482cf6528a7df06cd70ffdcb5b9a43e4b6d Mon Sep 17 00:00:00 2001
From: drifty <amoghtiwari@duck.com>
Date: Sat, 2 Aug 2025 14:11:42 +0530
Subject: [PATCH] Update README.md

---
 README.md | 29 +++++++++++++++++++++++++++--
 1 file changed, 27 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 53b439d..98bbdbb 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
-# twitchrise
-Script for sending apprise notifs when channels go live or offline 
+## An arm64 docker image for sending Apprise notifications for Live Twitch Channels made by drifty
+
+Also available on Docker Hub - [```driftywinds/twitchrise:latest```](https://hub.docker.com/repository/docker/driftywinds/twitchrise/general)
+
+### How to use: - 
+
+1. Download the ```compose.yml``` and ```.env``` files from the repo [here](https://github.com/driftywinds/twitchrise).
+2. Customise the ```.env``` file according to your needs.
+3. Run ```docker compose up -d```.
+
+<br>
+
+You can check logs live with this command: - 
+```
+docker compose logs -f
+```
+### For dev testing: -
+- have python3 installed on your machine
+- clone the repo
+- go into the directory and run these commands: -
+```
+python3 -m venv .venv
+source .venv/bin/activate
+pip install --no-cache-dir -r requirements.txt
+```  
+- configure ```.env``` variables.
+- then run ```python3 head.py```