README.md

Slack RI Bot

This is a UserBot for Slack chat written in Ruby. It provides RDoc documentation in your slack channel by the "ri" command line

Setting up the project

Dependencies

• Ruby 2.2.3
• RSpec
• slack-ruby-bot GEM

Required ENV var

• SLACK_API_TOKEN

bundle install
export SLACK_API_TOKEN=your-slack-token

Running

bundle exec ruby ribot.rb

or just

sh script/run

Testing

bundle exec rspec

Usage

In your slack channel

  <BOT-NAME> please explain <RUBY-METHOD>

Examples

  ribot please explain Hash#with_indifferent_access

  ribot please explain to_s