diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..8625f35 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,20 @@ +Copyright (c) 2011-2016 Robots And Pencils + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index 0a2f9f8..aa8d13f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,35 @@ # starter-ruby-bot ## Overview -Please visit the [Beep Boop Overview](https://beepboophq.com/docs/article/overview) to get the scoop on the the Beep Boop hosting platform and the role of the bot.yml and Dockerfile files. +A simple starting point for creating a Beep Boop hostable, Ruby based Slack bot. -Slack API documentation is [here](https://api.slack.com/) +Visit [Beep Boop](https://beepboophq.com/docs/article/overview) to get the scoop on the the Beep Boop hosting platform. The Slack API documentation can be found [here](https://api.slack.com/). -## Usage: +## Assumptions +* You have already signed up with [Beep Boop](https://beepboophq.com) and have a local fork of this project. +* You have sufficient rights in your Slack team to configure a bot and generate/access a Slack API token. -... +## Usage +### Run locally + bundle install + SLACK_TOKEN= ruby ./bot.rb + +Things are looking good if the console prints something like: + + Connected to team at https://.slack.com. + +### Run locally in Docker + docker build -t starter-ruby .` + docker run --rm -it -e SLACK_TOKEN= starter-ruby + +### Run in BeepBoop +If you have linked your local repo with the Beep Boop service (check [here](https://beepboophq.com/0_o/my-projects)), changes pushed to the remote master branch will automatically deploy. + +## Acknowledgements + +This code is influenced by and utilizes the awesome https://github.com/dblock/slack-ruby-client project by [@dblock](https://github.com/dblock). + +## License + +See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT). \ No newline at end of file