Added README

MouamleH · Sep 22, 2019 · fa5ee1d · fa5ee1d
1 parent 1bec86d
commit fa5ee1d
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# Telegram Github Automation
+
+## Setup
+
+- Clone the repo and get all the dependencies
+- Fill in the required info in `application.properties`
+- Setup a `webhook` in the required repo/repos to the path `<host>/hook` with the `Issues` event selected
+- Run/Build the app
+
+## Contribution
+**Feel free to submit a PR**