README.md in jekyll-slim-0.7.0 vs README.md in jekyll-slim-0.8.0
- old
+ new
@@ -1,7 +1,9 @@
# Jekyll-slim
+[![Gem Version](https://badge.fury.io/rb/jekyll-slim.png)](http://badge.fury.io/rb/jekyll-slim) [![Dependency Status](https://gemnasium.com/kaishin/jekyll-slim.png)](https://gemnasium.com/kaishin/jekyll-slim) [![Code Climate](https://codeclimate.com/github/kaishin/jekyll-slim.png)](https://codeclimate.com/github/kaishin/jekyll-slim)
+
A gem that adds [slim-lang](http://slim-lang.com) support to [Jekyll](http://github.com/mojombo/jekyll). Works for for pages, includes and layouts.
## Installation
Add this line to your Gemfile:
@@ -25,33 +27,30 @@
## Usage
The gem will convert all the `.slim` files in your project's directory into HTML. That includes files in sub-directories, includes and layouts. Example:
-```
+```haml
# _layouts/default.slim
html
head
body
.content-wrapper
| {{ content }}
```
+To include a partial, use the `slim` liquid tag instead of `include`:
-
-```
+```haml
# index.slim
---
layout: default
---
-section.content
- | {% include footer.slim %}
+section.content Content goes here.
+| {% slim footer.slim %}
```
-## Contributing
+## Credit
-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
+Jekyll-slim was heavily inspired by [jekyll-haml](https://github.com/samvincent/jekyll-haml). It is free software, and may be redistributed under the terms specified in the LICENSE file.
+