Telegrator
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/telegrator
. To experiment with that code, run bin/console
for an interactive prompt.
TODO: Delete this and the text above, and describe your gem
Installation
Add this line to your application's Gemfile:
gem 'telegrator'
And then execute:
$ bundle
Or install it yourself as:
$ gem install telegrator
Usage
You can easily set up a new bot project:
$ telegrator new foo_bot
This will generate a skeleton structure like this:
foo_bot/
|__ app/
|__ commands/
|__ keyboards/
|__ models/
|__ workers/
|__ commands.rb
|__ keyboards.rb
|__ models.rb
|__ workers.rb
|__ bin/
|__ bot
|__ config/
|__ boot.rb
|__ initializers/
|__ ...
|__ log/
|__ .keep
|__ Gemfile
|__ Rakefile
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run rake test
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/telegrator.
License
The gem is available as open source under the terms of the MIT License.