Initial commit

1 files changed, 22 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..fdbea79
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+meetfree is a bottle web app that serves iCalendar and Atom feeds for meetup.com groups. meetfree fetches data from meetup.com using its GraphQL API. The GraphQL API does not require any authentication.
+
+# Configuration
+
+meetfree is configured using environment variables.
+
+- *MEETFREE_BASE_URL*: Base URL on which meetfree is served. For example, `"https://meetfree.systemreboot.net"`
+- *MEETFREE_ALLOWED_GROUPS*: Space-separated list of group slugs to serve feeds for. Group slugs are the first path component of the meetup.com group URL: for example, `london-emacs-hacking` in `https://www.meetup.com/london-emacs-hacking/`. If this environment variable is not set, all groups are served; there is no restriction.
+
+# Run development server
+
+Run the script directly to run the development server.
+```
+python3 meetfree.py
+```
+
+# Deployment
+
+Deploy using gunicorn (or any other WSGI server). For example:
+```
+gunicorn -w 4 meetfree:app
+```