Update readme
diff --git a/README.md b/README.md
index fdd4dde..e0de46b 100644
--- a/README.md
+++ b/README.md
@@ -26,8 +26,8 @@
Template parse(String source, {bool lenient : false});
abstract class Template {
- String renderString(values, {bool lenient : false});
- void render(values, StringSink sink, {bool lenient : false});
+ String renderString(values, {bool lenient : false, bool htmlEscapeValues : true});
+ void render(values, StringSink sink, {bool lenient : false, bool htmlEscapeValues : true});
}
```
@@ -38,6 +38,8 @@
When lenient mode is enabled tag names may use any characters, otherwise only a-z, A-Z, 0-9, underscore and minus. Lenient mode will also silently ignore nulls passed as values.
+By default all variables are html escaped, this behaviour can be changed by passing htmlEscapeValues : false.
+
## Supported
```
@@ -45,13 +47,14 @@
Sections {{#section}}Blah{{/section}}
Inverse sections {{^section}}Blah{{/section}}
Comments {{! Not output. }}
+ Unescaped variables {{{ ... }}}
```
See the [mustache templates tutorial](http://mustache.github.com/mustache.5.html) for more information.
## To do
```
-Escape tags {{{ ... }}}, and {{& ... }}
-Partial tags {{>partial}}
+Unescaped variables (alternative syntax) {{& ... }}
+Partial tags {{>partial}}
Allow functions as values (See mustache docs)
Collect some test files, make a test harness to compare the output against another mustache lib.
```
