README.md in slim-rails-2.0.4 vs README.md in slim-rails-2.1.0
- old
+ new
@@ -1,12 +1,23 @@
# slim-rails
-slim-rails provides Slim generators for Rails 3 and 4. It was based on [haml-rails](http://github.com/indirect/haml-rails) and it does basically the same: configures Slim as the template engine automatically for your rails app.
+slim-rails provides Slim generators for Rails 3 and 4. It was based on
+[haml-rails](http://github.com/indirect/haml-rails) and it does basically the
+same:
+
+* Any time you generate a controller or scaffold, you'll get Slim templates
+ (instead of ERB)
+* When your Rails application loads, Slim will be loaded and initialized
+ automatically
+* Slim templates will be respected by the view template cache digestor
+
To use it, add this line to your Gemfile:
- gem "slim-rails"
+```ruby
+gem "slim-rails"
+```
And that's it.
From the version 0.2.0, there is no need to include gem "slim" in your Gemfile.
-Every time you generate a controller or scaffold, you'll get Slim templates.
+Every time you generate a controller or scaffold, you'll get Slim templates.
\ No newline at end of file