README.md in tramway-user-0.1.0 vs README.md in tramway-user-1.0

- old
+ new

@@ -1,35 +1,28 @@ # Tramway::User +Short description and motivation. -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/tramway/user`. To experiment with that code, run `bin/console` for an interactive prompt. +## Usage +How to use my plugin. -TODO: Delete this and the text above, and describe your gem - ## Installation - Add this line to your application's Gemfile: ```ruby gem 'tramway-user' ``` And then execute: +```bash +$ bundle +``` - $ bundle - Or install it yourself as: +```bash +$ gem install tramway-user +``` - $ gem install tramway-user - -## Usage - -TODO: Write usage instructions here - -## Development - -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. - -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 +Contribution directions go here. -Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tramway-user. +## License +The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).