README.md in spin_r-0.0.2.beta vs README.md in spin_r-0.1.0

- old
+ new

@@ -1,11 +1,15 @@ # SpinR -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/spin_r`. To experiment with that code, run `bin/console` for an interactive prompt. +[![GitHub tag](https://img.shields.io/github/tag/eendroroy/spin_r.svg)](https://github.com/eendroroy/spin_r) +[![Gem Version](https://badge.fury.io/rb/spin_r.svg)](https://rubygems.org/gems/spin_r) +[![Downloads](https://img.shields.io/gem/dt/spin_r.svg)](https://rubygems.org/gems/spin_r) +[![Contributors](https://img.shields.io/github/contributors/eendroroy/spin_r.svg)](CONTRIBUTORS.md) -TODO: Delete this and the text above, and describe your gem +Show any time consuming process's output with a spinner. + ## Installation Add this line to your application's Gemfile: ```ruby @@ -20,16 +24,40 @@ $ gem install spin_r ## Usage -TODO: Write usage instructions here +```ruby +SpinR.spin do + sleep 4 + puts 'You spin my head right round!' +end +``` -## Development +Define spinner style: -After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. +```ruby +SpinR.spin SpinR::Spinners::TRIANGLE do + sleep 4 + puts 'You spin my head right round!' +end +``` -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](https://rubygems.org). +Available spinners: + +- SpinR::Spinners::TRADITIONAL +- SpinR::Spinners::BLOCK +- SpinR::Spinners::DOTTED_1 +- SpinR::Spinners::DOTTED_2 +- SpinR::Spinners::DOTTED_3 +- SpinR::Spinners::DOTTED_4 +- SpinR::Spinners::WORLD +- SpinR::Spinners::TRIANGLE +- SpinR::Spinners::EMOJI + +## asciicast + +[![asciicast](http://asciinema.org/a/141149.png)](https://asciinema.org/a/141149) ## Contributing Bug reports and pull requests are welcome on GitHub at https://github.com/eendroroy/spin_r. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.