From 16e046e7e0d21dcc57f11eae1adfc5704e4d4d04 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adam=20W=C3=B3js?= Date: Sat, 24 Mar 2018 13:58:00 +0100 Subject: [PATCH] Create README.md --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..66386c5 --- /dev/null +++ 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 +``` +