From eaa2bcaa575faaadb37c070259f3f30f8fad51a2 Mon Sep 17 00:00:00 2001
From: Lunny Xiao <xiaolunwen@gmail.com>
Date: Sat, 11 May 2013 15:45:24 +0800
Subject: [PATCH] add documents' link for readme

---
 README.md    | 20 ++++++++++++++------
 README_CN.md | 18 +++++++++++++-----
 2 files changed, 27 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index 1065b6de..895ffa45 100644
--- a/README.md
+++ b/README.md
@@ -30,12 +30,16 @@ SQLite: [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
 
 ## Quick Start
 
-1.Create a database engine just like sql.Open (for example: mysql)
-
+1.Create a database engine just like sql.Open (for example: mysql)
+
+	import (_ "github.com/Go-SQL-Driver/MySQL"
+	 	"github.com/lunny/xorm")
 	engine := xorm.Create("mysql", "root:123@/test?charset=utf8")
 
 or
 
+	import (_ "github.com/mattn/go-sqlite3"
+		"github.com/lunny/xorm")
 	engine = xorm.Create("sqlite3", "./test.db")
 
 
@@ -68,14 +72,16 @@ or you want to update this struct
 
 	user := User{Name:"xlw"}
 	rows, err := engine.Update(&user, &User{Id:1})
-	// rows, err := engine.Where("id = ?", 1).Update(&user)
+	// or rows, err := engine.Where("id = ?", 1).Update(&user)
+	// or rows, err := engine.Id(1).Update(&user)
 
 
 3.Fetch a single object by user
 
 
 	var user = User{Id:27}
-	err := engine.Get(&user)
+	err := engine.Get(&user)
+	// or err := engine.Id(27).Get(&user)
 
 	var user = User{Name:"xlw"}
 	err := engine.Get(&user)
@@ -94,6 +100,7 @@ or you want to update this struct
 5.Delete and Count：
 
 	err := engine.Delete(&User{Id:1})
+	// or err := engine.Id(1).Delete(&User{})
 	
 	total, err := engine.Count(&User{Name:"xlw"})
 
@@ -233,14 +240,15 @@ another is use field tag, field tag support the below keywords:
     </tr>
 </table>
 
-
+##Documents
+Please visit [GoWalker](http://gowalker.org/github.com/lunny/xorm)
 ##FAQ
 1.How the xorm tag use both with json?
   
   use space
 
 	type User struct {
-    	User string `json:"user" orm:"user_id"`
+    	Name string `json:"name" xorm:"name"`
 	}
 
 ## LICENSE
diff --git a/README_CN.md b/README_CN.md
index 251a1c82..3bd46b06 100644
--- a/README_CN.md
+++ b/README_CN.md
@@ -31,11 +31,15 @@ SQLite: [github.com/mattn/go-sqlite3](https://github.com/mattn/go-sqlite3)
 ## 快速开始
 
 1.创建数据库引擎，这个函数的参数和sql.Open相同，但不会立即创建连接 (例如: mysql)
-
+
+	import (_ "github.com/Go-SQL-Driver/MySQL"
+	 	"github.com/lunny/xorm")
 	engine := xorm.Create("mysql", "root:123@/test?charset=utf8")
 
 or
 
+	import (_ "github.com/mattn/go-sqlite3"
+		"github.com/lunny/xorm")
 	engine = xorm.Create("sqlite3", "./test.db")
 
 
@@ -67,14 +71,16 @@ or
 
 	user := User{Name:"xlw"}
 	rows, err := engine.Update(&user, &User{Id:1})
-	// rows, err := engine.Where("id = ?", 1).Update(&user)
+	// rows, err := engine.Where("id = ?", 1).Update(&user)
+	// or rows, err := engine.Id(1).Update(&user)
 
 
 3.获取单个对象，可以用Get方法：
 
 
 	var user = User{Id:27}
-	err := engine.Get(&user)
+	err := engine.Get(&user)
+	// or err := engine.Id(27).Get(&user)
 
 	var user = User{Name:"xlw"}
 	err := engine.Get(&user)
@@ -93,6 +99,7 @@ or
 5.另外还有Delete和Count方法：
 
 	err := engine.Delete(&User{Id:1})
+	// or err := engine.Id(1).Delete(&User{})
 	
 	total, err := engine.Count(&User{Name:"xlw"})
 
@@ -232,7 +239,8 @@ UserInfo中的成员UserName将会自动对应名为user_name的字段。
         <td>-</td><td>这个Field将不进行字段映射</td>
     </tr>
 </table>
-
+##文档
+请访问 [GoWalker](http://gowalker.org/github.com/lunny/xorm) 查看详细文档
 
 ##FAQ
 1.xorm的tag和json的tag如何同时起作用？
@@ -240,7 +248,7 @@ UserInfo中的成员UserName将会自动对应名为user_name的字段。
   使用空格分开
 
 	type User struct {
-    	User string `json:"user" orm:"user_id"`
+    	Name string `json:"name" xorm:"name"`
 	}
 
 ## LICENSE