Renames EscapeString() to Escape() and adds an example

README.md

@@ -170,21 +170,21 @@ Output:
 </div>
 ```
 
-When returning HTML from a helper, you should return a `SafeString` if you don't want it to be escaped by default. When using `SafeString` all unknown or unsafe data should be manually escaped with the `EscapeString` method.
+When returning HTML from a helper, you should return a `SafeString` if you don't want it to be escaped by default. When using `SafeString` all unknown or unsafe data should be manually escaped with the `Escape` method.
 
 ```go
-  tpl := raymond.MustParse("{{{link text url}}}")
+  tpl := raymond.MustParse("{{{link url text}}}")
 
   tpl.RegisterHelper("link", func(h *raymond.HelperArg) interface{} {
-    text := raymond.EscapeString(h.ParamStr(0))
-    url := raymond.EscapeString(h.ParamStr(1))
+    url := raymond.Escape(h.ParamStr(0))
+    text := raymond.Escape(h.ParamStr(1))
 
     return raymond.SafeString("<a href='" + url + "'>" + text + "</a>")
   })
 
   ctx := map[string]string{
-    "text": "This is a <em>cool</em> website",
     "url":  "http://www.aymerick.com/",
+    "text": "This is a <em>cool</em> website",
   }
 
   result := tpl.MustExec(ctx)

escape.go

@@ -52,8 +52,10 @@ func escape(w writer, s string) error {
 	return err
 }
 
-// EscapeString escapes special HTML characters.
-func EscapeString(s string) string {
+// Escape escapes special HTML characters.
+//
+// It can be used by helpers that return a SafeString and that need to escape some content by themselves.
+func Escape(s string) string {
 	if strings.IndexAny(s, escapedChars) == -1 {
 		return s
 	}

escape_test.go

@@ -0,0 +1,23 @@
+package raymond
+
+import "fmt"
+
+func ExampleEscape() {
+	tpl := MustParse("{{{link url text}}}")
+
+	tpl.RegisterHelper("link", func(h *HelperArg) interface{} {
+		url := Escape(h.ParamStr(0))
+		text := Escape(h.ParamStr(1))
+
+		return SafeString("<a href='" + url + "'>" + text + "</a>")
+	})
+
+	ctx := map[string]string{
+		"url":  "http://www.aymerick.com/",
+		"text": "This is a <em>cool</em> website",
+	}
+
+	result := tpl.MustExec(ctx)
+	fmt.Print(result)
+	// Output: <a href='http://www.aymerick.com/'>This is a &lt;em&gt;cool&lt;/em&gt; website</a>
+}

eval.go

@@ -702,7 +702,7 @@ func (v *evalVisitor) VisitMustache(node *ast.MustacheStatement) interface{} {
 	str := Str(expr)
 	if !isSafe && !node.Unescaped {
 		// escape html
-		str = EscapeString(str)
+		str = Escape(str)
 	}
 
 	return str