[fix] doc变更

Author: Mrjing

README.md

@@ -1,10 +1,6 @@
 # Tencent Cloud Base(TCB) Server Node.js SDK
 
-[![NPM Version](https://img.shields.io/npm/v/@cloudbase/node-sdk/beta)](https://www.npmjs.com/package/@cloudbase/node-sdk)
-![node (scoped)](https://img.shields.io/node/v/@cloudbase/node-sdk)
-[![Coverage Status](https://coveralls.io/repos/github/TencentCloudBase/node-sdk/badge.svg?branch=master)](https://coveralls.io/github/TencentCloudBase/node-sdk?branch=master)
-
-> ⚠️ 当你计划在项目中使用 @cloudbase/node-sdk 替代 tcb-admin-node 时，请务必阅读[迁移文档](./docs/packageChange.md)
+> ⚠️ 当你计划在项目中使用 @cloudbase/node-sdk 替代 tcb-admin-node 时，请务必阅读[迁移文档](./docs/packageUpgrade.md)
 
 ## 目录
 
@@ -44,7 +40,7 @@ import tcb from '@cloudbase/node-sdk'
 
 -   [初始化](docs/initialization.md)
 -   [存储](docs/storage.md)
--   [数据库](docs/database.md)
+-   [数据库](docs/database/database.md)
 -   [云函数](docs/functions.md)
 -   [鉴权](./docs/auth.md)
 -   [环境](./docs/env.md)

docs/auth.md

@@ -1,33 +1,116 @@
-### 获取auth的引用
+# 登录鉴权
 
-```js
-const tcb = require('@cloudbase/node-sdk');
-const app = tcb.init({env:'xxx', credentials:'xxx'})
-const auth = app.auth();
-```
+## getUserInfo
+
+#### 1. 接口描述
+
+接口功能：获取用户信息
+
+接口声明：`getUserInfo(): Object`
+
+#### 2. 输入参数
+
+无
+
+#### 3. 返回结果
+
+| 字段         | 类型   | 必填 | 说明                                        |
+| ------------ | ------ | ---- | ------------------------------------------- |
+| openId       | string | 是   | 微信 openId，非微信授权登录则空             |
+| appId        | string | 是   | 微信 appId，非微信授权登录则空              |
+| uid          | string | 是   | 用户唯一 ID                                 |
+| customUserId | string | 是   | 开发者自定义的用户唯一 id，非自定义登录则空 |
 
-#### 获取用户信息
+#### 4. 示例代码
 
 ```js
-const {
-  openId, //微信openId，非微信授权登录则空
-  appId, //微信appId，非微信授权登录则空
-  uid, //用户唯一ID
-  customUserId //开发者自定义的用户唯一id，非自定义登录则空
-} = auth.getUserInfo()
+const tcb = require('@cloudbase/node-sdk')
+const app = tcb.init({ env: 'xxx' })
+const auth = app.auth()
+
+exports.main = async (event, context) => {
+  const {
+    openId, //微信openId，非微信授权登录则空
+    appId, //微信appId，非微信授权登录则空
+    uid, //用户唯一ID
+    customUserId //开发者自定义的用户唯一id，非自定义登录则空
+  } = auth.getUserInfo()
+  console.log(openId, appId, uid, customUserId)
+}
 ```
 
-#### 获取客户端IP
+## getClientIP
+
+#### 1. 接口描述
+
+接口功能：获取客户端 IP
+
+接口声明：`getClientIP(): string`
+
+#### 2. 输入参数
+
+无
+
+#### 3. 返回结果
+
+| 字段 | 类型   | 必填 | 说明      |
+| ---- | ------ | ---- | --------- |
+| -    | string | 是   | 客户端 IP |
+
+#### 4. 示例代码
+
 ```js
-const ip = auth.getClientIP()
+const tcb = require('@cloudbase/node-sdk')
+const app = tcb.init({ env: 'xxx' })
+const auth = app.auth()
+
+exports.main = async (event, context) => {
+  const ip = auth.getClientIP() // string
+  console.log(ip)
+}
 ```
 
-#### 获取自定义登录的登录凭据ticket
+## createTicket
+
+#### 1. 接口描述
+
+接口功能：获取自定义登录的登录凭据 ticket
+
+接口声明：`createTicket(): string`
+
+#### 2. 输入参数
+
+| 字段         | 类型   | 必填 | 说明                           |
+| ------------ | ------ | ---- | ------------------------------ |
+| customUserId | string | 是   | 开发者自定义的用户唯一 id      |
+| option       | string | 是   | 微信 appId，非微信授权登录则空 |
+
+#### option
+
+| 字段    | 类型   | 必填 | 说明                    |
+| ------- | ------ | ---- | ----------------------- |
+| refresh | number | 否   | access_token 的刷新时间 |
+| expire  | number | 否   | access_token 的过期时间 |
+
+#### 3. 返回结果
+
+| 字段 | 类型   | 必填 | 说明                  |
+| ---- | ------ | ---- | --------------------- |
+| -    | string | 是   | 自定义登录凭据 ticket |
+
+#### 4. 示例代码
 
 ```js
+const tcb = require('@cloudbase/node-sdk')
+const app = tcb.init({ env: 'xxx' })
+
+const auth = app.auth()
+
 const customUserId = '123456' // 开发者自定义的用户唯一id
 
 const ticket = auth.createTicket(customUserId, {
-  refresh: 3600 * 1000, // access_token的刷新时间
+  refresh: 3600 * 1000 // access_token的刷新时间
 })
+
+console.log(ticket)
 ```