Update README.md

lloydzhou · lloydzhou · commit a20d80fd23df · 2015-12-27T22:42:15.000+08:00
diff --git a/README.md b/README.md
@@ -1,7 +1,36 @@
 # lua-resy-template
 Simple template engine for lua and openresty
 
-# Syntax
+# Methods
+
+## new
+`syntax: t = template.new(callback, minify, tags)`
+
+create new template instance, all params is optional  
+the default value of callback is "io.write" or "ngx.print"  
+the default value of minify is false
+the default value of tags is {"{{", "}}", "{%%", "%%}"}  
+
+## parse
+`syntax: code = t:parse(tmpl, minify)`
+
+parse the template into lua code.
+
+## compile
+`syntax: func = t:compile(tmpl, minify)`
+
+compile the template into lua function, this method will call parse method.  
+this method will auto cache the compiled function.
+
+## render
+`syntax: t:render(tmpl_or_func, data, callback, minify)`
+
+render the template with variables stored in data, 
+the first param can be template string or compiled function.  
+the callback and minify params will replace the default value gived from "new" method.
+
+
+# Template Syntax
 
 In short, statements must be included between percent signs and expressions must be placed between brackets.
 
@@ -30,4 +59,29 @@ variables or expressions will be replaced
 
 # Demo 
 
-please see detail in "test.lua"
+the test demo in file "test.lua"
+
+    local template = require "lib.resty.template"
+    local t = template.new()
+    local tmpl = [[
+    <h1>{{title}}</h1>
+    <h2>{{title .. " -" .. '- ' .. subtitle}}</h2>
+    {% if messages then %}
+        {% for i, message in ipairs(messages) do %}
+            <p>{{message}}</p>
+        {% end %}
+    {% end %}
+    {% local testvar = 'set val in template'%}{{ testvar }}
+    ]]
+    local data = {title = 'Title', subtitle = 'Sub Title', messages = {'test message 1', 'test message 2'}}
+    t:render(tmpl, data)
+
+will get result:
+
+    <h1>Title</h1>
+    <h2>Title -- Sub Title</h2>
+            <p>test message 1</p>
+            <p>test message 2</p>
+        set val in template
+    
+    
