diff --git a/README.md b/README.md new file mode 100644 index 0000000..1eed3e3 --- /dev/null +++ b/README.md @@ -0,0 +1,28 @@ +# Beaverhabits - CalDAV bridge + +This is a simple container that can connect to Beaverhabits and run a calDAV server that hosts the habits as tasks. + +It was mostly generated by AI (Gemini + GPT) and may have bad code, security problems or poor performance, but for anyone else who wants a quick fix, here it is. + +I made this to use with Home Assistant's CalDAV integration so I didn't have to write a custom integration. + +## Usage + +Start up the container with docker-compose + +```yaml +version: '3.8' + +services: + caldav-bridge: + build: + context: ./bridge + ports: + - "8004:8000" + environment: + # FILL THESE IN + BEAVERHABITS_URL: "" + BEAVERHABITS_USERNAME: "" # yes i know this is bad + BEAVERHABITS_PASSWORD: "" # however, i don't care + restart: unless-stopped +``` \ No newline at end of file