docs: basic run config and commands

replikativ · Mar 24, 2022 · 5c80ca6 · 5c80ca6
1 parent 1cd1a29
commit 5c80ca6
Showing 1 changed file with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,18 @@
 # souffleuse
-A chatbot that announces meetings and releases
+A chatbot that announces meetings and releases on Slack and Twitter
+
+## Configuration
+
+Environment variables:
+
+- `GITHUB_TOKEN` (The token you get from GitHub Webhooks)
+- `SLACK_HOOK_URL` (Just a url that is unique for your integration)
+- `TWITTER_API_KEY`
+- `TWITTER_API_SECRET`
+- `TWITTER_ACCESS_TOKEN`
+- `TWITTER_ACCESS_TOKEN_SECRET`
+
+## Running
+
+Either via container: https://hub.docker.com/r/replikativ/souffleuse
+or the uberjar `java -jar target/souffleuse-0.1.8`.