improved docs

This commit is contained in:
Lunny Xiao 2013-11-22 16:11:32 +08:00
parent 605ec87f65
commit 36919468aa
2 changed files with 21 additions and 11 deletions

1
doc.go
View File

@ -5,6 +5,7 @@
/* /*
Package xorm is a simple and powerful ORM for Go. Package xorm is a simple and powerful ORM for Go.
Installation Installation
go get github.com/lunny/xorm go get github.com/lunny/xorm

View File

@ -26,10 +26,12 @@ xorm 快速入门
* [10.执行SQL命令](#100) * [10.执行SQL命令](#100)
* [11.事务处理](#110) * [11.事务处理](#110)
* [12.缓存](#120) * [12.缓存](#120)
* [13.Examples](#130) * [13.xorm工具](#130)
* [14.案例](#140) * [13.1.反转命令](#131)
* [15.那些年我们踩过的坑](#150) * [14.Examples](#140)
* [16.讨论](#160) * [15.案例](#150)
* [16.那些年我们踩过的坑](#160)
* [17.讨论](#170)
<a name="10" id="10"></a> <a name="10" id="10"></a>
## 1.创建Orm引擎 ## 1.创建Orm引擎
@ -611,12 +613,19 @@ ClearCacheBean
![cache design](https://raw.github.com/lunny/xorm/master/docs/cache_design.png) ![cache design](https://raw.github.com/lunny/xorm/master/docs/cache_design.png)
<a name="130" id="130"></a> <a name="130" id="130"></a>
## 13.Examples ## 13.xorm工具
xorm工具提供了xorm命令能够帮助做很多事情。
### 13.1.反转命令
参见 [xorm工具](https://github.com/lunny/xorm/tree/master/xorm)
<a name="140" id="140"></a>
## 14.Examples
请访问[https://github.com/lunny/xorm/tree/master/examples](https://github.com/lunny/xorm/tree/master/examples) 请访问[https://github.com/lunny/xorm/tree/master/examples](https://github.com/lunny/xorm/tree/master/examples)
<a name="140" id="140"></a> <a name="150" id="150"></a>
## 14.案例 ## 15.案例
* [Gowalker](http://gowalker.org),源代码 [github.com/Unknwon/gowalker](http://github.com/Unknwon/gowalker) * [Gowalker](http://gowalker.org),源代码 [github.com/Unknwon/gowalker](http://github.com/Unknwon/gowalker)
@ -626,8 +635,8 @@ ClearCacheBean
* [VeryHour](http://veryhour.com) * [VeryHour](http://veryhour.com)
<a name="150" id="150"></a> <a name="160" id="160"></a>
## 15.那些年我们踩过的坑 ## 16.那些年我们踩过的坑
1. 怎么同时使用xorm的tag和json的tag 1. 怎么同时使用xorm的tag和json的tag
答:使用空格 答:使用空格
@ -655,6 +664,6 @@ money float64 `xorm:"Numeric"`
} }
``` ```
<a name="160" id="160"></a> <a name="170" id="170"></a>
## 16.FAQ ## 17.FAQ
请加入QQ群280360085 进行讨论。 请加入QQ群280360085 进行讨论。