From 0e525b86e0a5d43fce17e0b506cfb7387588ceed Mon Sep 17 00:00:00 2001
From: richie <richie@fanruan.com>
Date: Fri, 9 Aug 2019 17:01:21 +0800
Subject: [PATCH] =?UTF-8?q?=E5=A3=B0=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/claim.md |  0
 readme.md     | 10 ++++++++--
 2 files changed, 8 insertions(+), 2 deletions(-)
 create mode 100644 docs/claim.md

diff --git a/docs/claim.md b/docs/claim.md
new file mode 100644
index 0000000..e69de29
diff --git a/readme.md b/readme.md
index ac4a123..6a958d8 100644
--- a/readme.md
+++ b/readme.md
@@ -1,10 +1,11 @@
 # 帆软插件开发工具套件
 
+## 作用简介
 该套件在帆软工程类基础上做了二次封装，仅暴露接口，可以更好的兼容不同版本的非开放API。
 
 比如，要获取报表的会话信息，以前需要调用方法
 ```java
-SessionPoolManager#getSessionIDInfor(String sessionID, Class<T> clazz);
+SessionPoolManager#getSessionIDInfor(@NotNull String sessionID, Class<T> clazz);
 ```
 但可能随着版本的变更，SessionPoolManager变更了一个名字，比如由SessionPoolManager改成了NewSessionPoolManager，
 那么所有调用了该API的插件都无法使用，必须要重新修改插件中的该处代码并更新插件才行。
@@ -13,4 +14,9 @@ SessionPoolManager#getSessionIDInfor(String sessionID, Class<T> clazz);
 ```java
 SessionFactory#getSession(@NotNull String sessionID);
 ```
-仅仅只需要更新最新版本的开发套件工具包即可让老插件自然适配。
\ No newline at end of file
+仅仅只需要更新最新版本的开发套件工具包即可让老插件自然适配。
+
+## 提交新API要求
+
+* 所有的API方法的返回值和参数，仅允许使用基本类型或者接口类型。
+* 所有的API方法均需要有单元测试覆盖。
\ No newline at end of file