README.md in myrails-1.0.0 vs README.md in myrails-1.0.1
- old
+ new
@@ -1,11 +1,13 @@
# Myrails
This gem was created to make generating rails related files and other rails gem files (that I use) a lot easier. It is a thor backed gem that was designed with rails 5 in mind but most of it "should" work with rails 4.
-This gem is not endorsed by 37signals. I wrote it as a convenience for my style of development.
+This gem is not endorsed by 37signals. I wrote it as a convenience for generating files that I would otherwise have written by hand.
+NOTE: This gem is not compatible with ruby 2.3 (yet).
+
Here is an example of the gem in action:
For example, I use pundit. With this gem I am able to run the following:
```ruby
@@ -53,13 +55,16 @@
## 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,
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Releasing
+To release a new version,
* update the version number in `version.rb`
* tag the the code `git tag v1.0.0`
-* puts the tag `git push --tags`
+* push the tag `git push --tags`
* then run `bundle exec rake build`
* `gem push pkg/myrails-verion`
Which will push the `.gem` file to [rubygems.org](https://rubygems.org).