Add build status and small copy changes in the README

This commit is contained in:
Jonathan Rudenberg 2011-06-30 16:36:49 -04:00
parent 4aaf750fa8
commit a8ed72a036

View File

@ -2,13 +2,13 @@
## Introduction
Liquid is a template engine which I wrote for very specific requirements
Liquid is a template engine which was written with very specific requirements:
* It has to have beautiful and simple markup. Template engines which don't produce good looking markup are no fun to use.
* It needs to be non evaling and secure. Liquid templates are made so that users can edit them. You don't want to run code on your server which your users wrote.
* It has to be stateless. Compile and render steps have to be seperate so that the expensive parsing and compiling can be done once and later on you can just render it passing in a hash with local variables and objects.
## Why should I use Liquid
## Why you should use Liquid
* You want to allow your users to edit the appearance of your application but don't want them to run **insecure code on your server**.
* You want to render templates directly from the database
@ -19,16 +19,16 @@ Liquid is a template engine which I wrote for very specific requirements
## What does it look like?
```html
<ul id="products">
{% for product in products %}
<li>
<h2>{{product.name}}</h2>
Only {{product.price | price }}
<ul id="products">
{% for product in products %}
<li>
<h2>{{ product.name }}</h2>
Only {{ product.price | price }}
{{product.description | prettyprint | paragraph }}
</li>
{% endfor %}
</ul>
{{ product.description | prettyprint | paragraph }}
</li>
{% endfor %}
</ul>
```
## Howto use Liquid
@ -38,5 +38,7 @@ For standard use you can just pass it the content of a file and call render with
```ruby
@template = Liquid::Template.parse("hi {{name}}") # Parses and compiles the template
@template.render( 'name' => 'tobi' ) # => "hi tobi"
```
@template.render('name' => 'tobi') # => "hi tobi"
```
[![Build Status](https://secure.travis-ci.org/Shopify/liquid.png)](http://travis-ci.org/Shopify/liquid)