From ffcd669898cea44fa0aace8913e053f3f74f04ac Mon Sep 17 00:00:00 2001
From: ibuler <ibuler@qq.com>
Date: Tue, 9 Aug 2016 19:37:55 +0800
Subject: [PATCH] =?UTF-8?q?=E4=BF=AE=E6=94=B9readme=E6=98=BE=E7=A4=BA?=
 =?UTF-8?q?=EF=BC=8C=E9=87=87=E7=94=A8=E7=9B=B8=E5=AF=B9=E8=B7=AF=E5=BE=84?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md               | 7 ++++++-
 docs/README.md          | 4 ++--
 docs/api_style_guide.md | 6 +++++-
 3 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 1026fe8f8..b8f5d3170 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,9 @@
 
 
 
-## [文档](https://code.simcu.com/jumpserver/jumpserver/tree/master/docs)
\ No newline at end of file
+## [文档和规范]
+
+## [项目结构描述](/jumpserver/jumpserver/blob/master/docs/project_structure.md)
+## [Python代码规范](/jumpserver/jumpserver/blob/master/docs/python_style_guide.md)
+## [API设计规范](/jumpserver/jumpserver/blob/master/docs/api_style_guide.md)
+
diff --git a/docs/README.md b/docs/README.md
index 4ee418c76..8f1ba473d 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,2 +1,2 @@
-## [代码规范](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/code_style.md)
-## [项目结构](https://code.simcu.com/jumpserver/jumpserver/blob/master/docs/project_structure.md)
+## [代码规范](/jumpserver/jumpserver/blob/master/docs/code_style.md)
+## [项目结构](/jumpserver/jumpserver/blob/master/docs/project_structure.md)
diff --git a/docs/api_style_guide.md b/docs/api_style_guide.md
index 1bdc8a4cc..67a8c790a 100644
--- a/docs/api_style_guide.md
+++ b/docs/api_style_guide.md
@@ -1,6 +1,10 @@
 ## REST API规范约定
 
-这里仅考虑REST API的基本情况。
+这里仅考虑REST API的基本情况。参考 
+
+[RESTful API 设计指南](http://www.ruanyifeng.com/blog/2014/05/restful_api.html)
+
+[github api文档](https://developer.github.com/v3/)
 
 ### 协议