README.md in hamlit-rails-0.2.1 vs README.md in hamlit-rails-0.2.2
- old
+ new
@@ -1,12 +1,12 @@
Hamlit-rails
============
-[](https://travis-ci.org/mfung/hamlit-rails) [](http://badge.fury.io/rb/hamlit-rails) [](https://codeclimate.com/github/mfung/hamlit-rails) [](https://codeclimate.com/github/mfung/hamlit-rails/coverage)
+[](https://travis-ci.org/mfung/hamlit-rails) [](http://badge.fury.io/rb/hamlit-rails)
-Provides hamlit generators for Rails 4. It also enables hamlit as the templating
-engine and "hamlit:html2haml" rake task that converts erb files to haml.
+Provides hamlit generators for Rails. It also enables hamlit as the templating
+engine and "hamlit:erb2haml" rake task that converts erb files to haml.
## Installation
Add this line to your application's Gemfile:
@@ -22,18 +22,18 @@
$ gem install hamlit-rails
## Usage
-TODO: Write usage instructions here
+By installing this gem, Haml templates are generated on `rails g`.
-## Development
+Also, use the following rake task to convert .erb to .haml:
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+bundle exec rake hamlit:erb2haml
+```
-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` to 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 ( https://github.com/mfung/hamlit-rails/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
@@ -44,6 +44,6 @@
This code is heavily influenced by [haml-rails](https://github.com/indirect/haml-rails).
And is written because of an issue created in that repo.
## License
-MIT license
\ No newline at end of file
+MIT license