Skip to content

Commit

Permalink
Update README to include usage and LICENSE reference.
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-skud committed Jan 13, 2016
1 parent 845adeb commit 767a459
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 4 deletions.
20 changes: 20 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -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.
32 changes: 28 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -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=<YOUR SLACK TOKEN> ruby ./bot.rb

Things are looking good if the console prints something like:

Connected <your bot name> to <your slack team> team at https://<your slack team>.slack.com.

### Run locally in Docker
docker build -t starter-ruby .`
docker run --rm -it -e SLACK_TOKEN=<YOUR SLACK API 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).

0 comments on commit 767a459

Please sign in to comment.