Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yivo committed Sep 18, 2016
1 parent 4e7acd9 commit 899e422
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
## Ruby wrapper for the Pug/Jade template engine

## About
This gem uses [pug-ruby](https://github.com/yivo/pug-ruby) to compile Pug/Jade templates. Please refer to that gem if you want to use Pug/Jade compiler directly.
This gem is wrapper for Pug/Jade command line interface. You can compile both Jade templates ([version 1.x](https://github.com/pugjs/pug/tree/v1.x.x)) and Pug ([version 2.x](https://github.com/pugjs/pug)).
<br>
```ruby
Jade.compile(source, options)
Pug.compile(source, options)
```

## Installing gem
Run `gem install pug-ruby -v '~> 1.0'`. Add `require 'pug-ruby'` to your code.


**If you are using bundler.**
<br>
Add to your Gemfile:
Expand Down

0 comments on commit 899e422

Please sign in to comment.