Project

slatan

0.0
No commit activity in last 3 years
No release in over 3 years
Gem to create bot for Slack easily and flexibly.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.10
~> 10.0
>= 0

Runtime

 Project Readme

Slatan

Ruby gem to create bot for Slack easily and flexibly.

Installation

Add this line to your application's Gemfile:

gem 'slatan'

And then execute:

$ bundle

Or install it yourself as:

$ gem install slatan

Usage

1. Add 'Bot' integration and cory API token on Slack.

2. Generate event subscriber class.

$ (bundle exec) slatan generate /path/to/your/preference/test.rb'

3. Write code to running slatan.

require 'slatan'
require 'path/to/your/preference/test.rb'

Slatan::Spirit.slack_token = 'xxxx-xxxxxx-xxxxxxxxxx'   #or `export SLACK_TOKEN=xxxxx-xxxx-xxxxxxxxxx`

Slatan::Ear.register(Test.new)   #register event subscriber

Slatan.run   #write 'Slatan.run({ daemonize: true })' if you want to run daemonize mode.

4. type 'ping' on Slack

slatan example

##Documentation Under construction...

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/kudohamu/slatan.

License

The gem is available as open source under the terms of the MIT License.