From 8c2dee2af02746f9d8df602cdf1ed3aea723aee9 Mon Sep 17 00:00:00 2001
From: Izan Gil <66965250+SrIzan10@users.noreply.github.com>
Date: Sun, 19 Apr 2026 19:54:15 +0200
Subject: [PATCH] docs: readme

---
 README.md | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 60b2a70..ff41af6 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,23 @@
 # wacals
 
-To install dependencies:
+simple whatsapp calendar notifier. it uses a rest api where you can feed it data through a post request, in case your organization blocks oauth but allows google script.
+
+## install
 
 ```bash
 bun install
 ```
 
-To run:
+## run
 
-```bash
-bun run index.ts
+populate env:
+```
+REDIS_URL=""
+# you are better off generating this with "openssl rand -base64 32"
+AUTH_KEY="asdfasdasddfasdfasddf"
+CHAT_ID=""
 ```
 
-This project was created using `bun init` in bun v1.3.5. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+```bash
+bun run src/index.ts
+```