README.md in rash-shell-0.1.1 vs README.md in rash-shell-0.2.0

- old
+ new

@@ -1,11 +1,9 @@ # Rash::Shell -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/rash/shell`. To experiment with that code, run `bin/console` for an interactive prompt. +Like [racksh](https://github.com/sickill/racksh), but different. -TODO: Delete this and the text above, and describe your gem - ## Installation Add this line to your application's Gemfile: ```ruby @@ -20,21 +18,31 @@ $ gem install rash-shell ## Usage -TODO: Write usage instructions here +``` +$ rash +rash-shell shell started in development environment. Happy Hackin' +rash-shell [development] % +``` + ## 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. Run `bundle exec rash-shell` to use the gem in this directory, ignoring other installed copies of this gem. +To release a new version, update the version number in `version.rb`, and then +run `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). -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). - ## Contributing -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rash-shell. 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. +Bug reports and pull requests are welcome on GitHub at +<https://github.com/JeanMertz/rash-shell>. 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. - ## License -The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). +The gem is available as open source under the terms of the [MIT +License](http://opensource.org/licenses/MIT).