From 21f767784bf4865b8aa6a144e5a56dbf28e34ee0 Mon Sep 17 00:00:00 2001
From: miraclesu <suchuangji@gmail.com>
Date: Thu, 7 Jan 2016 22:55:12 +0800
Subject: [PATCH] Add custom validation function doc

---
 validation/README.md | 43 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/validation/README.md b/validation/README.md
index b4fc3fe5..5c3212b0 100644
--- a/validation/README.md
+++ b/validation/README.md
@@ -63,7 +63,48 @@ Struct Tag Use:
 	}
 
 	func main() {
-		valid := Validation{}
+		valid := validation.Validation{}
+		u := user{Name: "test", Age: 40}
+		b, err := valid.Valid(u)
+		if err != nil {
+			// handle error
+		}
+		if !b {
+			// validation does not pass
+			// blabla...
+		}
+	}
+
+Use custom function:
+
+	import (
+		"github.com/astaxie/beego/validation"
+	)
+
+	type user struct {
+		Id   int
+		Name string `valid:"Required;IsMe"`
+		Age  int    `valid:"Required;Range(1, 140)"`
+	}
+
+	func IsMe(v *validation.Validation, obj interface{}, key string) {
+		name, ok:= obj.(string)
+		if !ok {
+			// wrong use case?
+			return
+		}
+
+		if name != "me" {
+			// valid false
+			v.SetError("Name", "is not me!")
+		}
+	}
+
+	func main() {
+		valid := validation.Validation{}
+		if err := validation.AddCustomFunc("IsMe", IsMe); err != nil {
+			// hadle error
+		}
 		u := user{Name: "test", Age: 40}
 		b, err := valid.Valid(u)
 		if err != nil {