Add readme file

giantswarm · Jan 17, 2019 · 5ae6c2e · 5ae6c2e
1 parent 6189d5e
commit 5ae6c2e
Showing 1 changed file with 23 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+[![CircleCI](https://circleci.com/gh/giantswarm/auto-oncall.svg?&style=shield&circle-token=03d2446a590221c8604e7f540ea4cd1a4b929f14)](https://circleci.com/gh/giantswarm/auto-oncall)
+
+# auto-oncall
+auto-oncall application is a webhook handler, responsible for creating new Opsgenie routing rules on every merge event into master branch.
+
+# configuration
+Configuration requires next data to be configured in `values.yaml` of the helm chart:
+
+```
+# opsgenie api token
+opsgenieToken:
+
+# list of applications, configured for automated oncall rules
+repositories:
+  - test-oncall
+
+# user mapping between github login and Opsgenie login 
+users:
+  github_user: [email protected]
+
+# organization github webhook secret
+githubWebhookSecret: 
+```