lib/hexx/domains/cli/root/README.md.erb in hexx-domains-0.0.1 vs lib/hexx/domains/cli/root/README.md.erb in hexx-domains-0.0.2
- old
+ new
@@ -1,6 +1,7 @@
-# Hexx
+<%= project.type %>
+===================
[][gem]
[][travis]
[][gemnasium]
[][codeclimate]
@@ -14,16 +15,13 @@
[travis]: https://travis-ci.org/<%= user %>/<%= project.file %>
[inch]: https://inch-ci.org/github/<%= user %>/<%= project.file %>
@todo Describe the module
-## Usage
+Installation
+------------
-@todo Describe the base usage of the module
-
-## Installation
-
Add this line to your application's Gemfile:
```ruby
# Gemfile
gem "<%= project.file %>"
@@ -39,26 +37,41 @@
```
gem install <%= project.file %>
```
-## Compatibility
+Usage
+-----
-Tested under rubies compatible to MRI <%= ruby %>+.
+@todo Describe howto use the module
-Uses [RSpec] 3.0+ for testing and [<%= project.file %>-suit] for dev/test tools collection.
+Compatibility
+-------------
-## Contributing
+Tested under rubies compatible to rubies compatible to API <%= ruby %>+:
+* MRI <%= ruby %>+
+* Rubinius (mode <%= ruby %>+)
+* JRuby (mode <%= ruby %>+)
+
+Uses [RSpec] 3.0+ for testing and [hexx-suit] for dev/test tools collection.
+
+[RSpec]: http://rspec.info/
+[hexx-suit]: http://github.com/nepalez/hexx-suit
+
+Contributing
+------------
+
* Fork the project.
* Read the [STYLEGUIDE](config/metrics/STYLEGUIDE).
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with Rakefile or version
(if you want to have your own version, that is fine but bump version
in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
-## License
+License
+-------
See the [MIT LICENSE](LICENSE).