docs: readme

This commit is contained in:
2026-04-19 19:54:15 +02:00
parent 9d69b40615
commit 8c2dee2af0

View File

@@ -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
```