Create README.md

adamwojs · Mar 24, 2018 · 16e046e · 16e046e
1 parent e87fcce
commit 16e046e
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# awokado.robot
+
+Slack bot providing Awokado Lunch Bar menu for today
+
+![Screenshot](https://www.dropbox.com/s/kzrvihbnut3u1lv/Awokado%32Robot%32Preview.png?raw=1)
+
+## Installation 
+
+1. If you don't have it already, install [Composer](https://getcomposer.org/download/)
+2. Download `awokado.robot` by cloning this repository `git clone https://github.com/adamwojs/awokado.robot.git`  
+3. `cd awokado.robot`
+4. Install dependencies `composer install` 
+
+## Usage
+
+```sh
+php awokado-robot <incoming-webhook-url>
+```
+