whitslar / slack-ruby-progress-bar

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SlackRubyProgressBar

A Slack progress bar for Ruby.

Inspired by: https://github.com/bcicen/slack-progress

Installation

Add this line to your application's Gemfile:

gem 'slack-ruby-progress-bar'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install slack-ruby-progress-bar

Usage

progress_bar = SlackRubyProgressBar.new(channel: '#some-channel', username: 'some-username', slack_token: 'some-token', bar_color: 'blue')
progress_bar.update(progress: 1)
progress_bar.update(progress_text: 'one percent complete')
progress_bar.update(progress: 10, progress_text: 'ten percent complete')
progress_bar.increment
progress_bar.clear
progress_bar.finish

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/whitslar/slack-ruby-progress-bar. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the SlackRubyProgressBar project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

License:MIT License


Languages

Language:Ruby 98.9%Language:Shell 1.1%