diff --git a/README.md b/README.md index 6942708..9793ded 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,31 @@ -bot -=== +# bot -bot is our friendly robot that sits on sdslabs chat and helps us in lots of things. -It is powered by Hubot (by GitHub), and uses some custom scripts as well. +bot is our friendly robot that sits on SDSLabs Slack and helps us in lots of things. +It is powered by Hubot (by GitHub), and have been personalized for our use case. -This is hosted on the heroku free tier, and we use jsonblob.com as the brain storage -service. +This is hosted on the Heroku Free tier, and we use https://github.com/sdslabs/botdb as the brain storage +service. This can be changed to use https://jsonblob.com too (`botdb` and JSON Blob use the same API endpoints). -Set-up Instructions -=================== +## Set-up Instructions -After cloning repository, run the following command in the terminal: +1. Setup [botdb](https://github.com/sdslabs/botdb) using the setup instructions. -JSONBLOB_URL="{JSONBLOB_URL}" INFO_SPREADSHEET_URL="{INFO_SPREADSHEET_URL}" bin/hubot +2. Clone this repository at your desired location -The config variables can be found from the heroku account. +```bash + git clone https://github.com/sdslabs/bot + cd bot +``` + +3. Prepare a Google Sheet using this template and enable link sharing + +4. Setup environment variables + +```bash + export JSONBLOB_URL="http://localhost:5050/" + export JSONBLOB_TOKEN="token_set_in_botdb" + export INFO_SPREADSHEET_URL="csv_export_url_of_link" +``` + +5. Run the bot for testing using `./bin/hubot`