README.md in write_down-0.0.5 vs README.md in write_down-0.2.0

- old
+ new

@@ -1,14 +1,18 @@ # WriteDown -yet another static blog generator +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/write_down`. 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 'write_down' +```ruby +gem 'write_down' +``` And then execute: $ bundle @@ -16,14 +20,22 @@ $ gem install write_down ## Usage - $ write_down source dist +TODO: Write usage instructions here +## 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 write_down` to use the gem in this directory, ignoring other installed copies of this gem. + +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 -1. Fork it -2. Create your feature branch (`git checkout -b my-new-feature`) -3. Commit your changes (`git commit -am 'Add some feature'`) -4. Push to the branch (`git push origin my-new-feature`) -5. Create new Pull Request +Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/write_down. + + +## License + +The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). +