README

README.md

@@ -0,0 +1,15 @@
+# Kalendasz
+
+Mini-proxy allowing Discourse users to automatically export their entire calendars as iCalendar.
+It performs the following functions:
+
+1. Automates User API Key creation flow.
+2. Automates `events.ics` URL generation.
+3. Proxies requests in order to pass the `user_api_key` argument as `User-Api-Key` header.
+
+## Usage
+
+1. Create a config file based on the example.
+2. Run the app like this: `python app.py /config.yaml`.
+
+Creating a virtualenv or handling Docker is left as an exercise to the reader.

config.example.yaml

@@ -1,4 +1,4 @@
+app_url: "https://myapp.example.com"
 forum_url: "https://forum.example.com"
-redirect_url: "https://myapp.example.com/callback"
 application_name: "My Calendar App"
 secret_key: "change-me-to-a-long-random-string"