From 899e422614941fb3e4164f10ee4d4235ac500ffa Mon Sep 17 00:00:00 2001 From: Yaroslav Konoplov Date: Mon, 19 Sep 2016 02:07:04 +0300 Subject: [PATCH] Update readme --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ea21944..45ff83c 100644 --- a/README.md +++ b/README.md @@ -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)). +
+```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.**
Add to your Gemfile: