docs(api): 补充文档遗漏的地域参数 (#85)

twikoojs · Dec 31, 2020 · 68bb609 · 68bb609
1 parent 54e0c0b
commit 68bb609
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -17,6 +17,7 @@
 ``` js
 twikoo.getCommentsCount({
   envId: '您的环境id', // 环境 ID
+  // region: 'ap-guangzhou', // 环境地域，默认为 ap-shanghai，如果您的环境地域不是上海，需传此参数
   urls: [ // 不包含协议、域名、参数的文章路径列表，必传参数
     '/2020/10/post-1.html',
     '/2020/11/post-2.html',
@@ -49,6 +50,7 @@ twikoo.getCommentsCount({
 ``` js
 twikoo.getRecentComments({
   envId: '您的环境id', // 环境 ID
+  // region: 'ap-guangzhou', // 环境地域，默认为 ap-shanghai，如果您的环境地域不是上海，需传此参数
   pageSize: 10, // 获取多少条，默认：10，最大：100
   includeReply: false // 是否包括最新回复，默认：false
 }).then(function (res) {

diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -24,6 +24,7 @@ Twikoo 使用云开发作为评论后台，每个云开发用户均长期享受1
 1. [注册云开发CloudBase](https://curl.qcloud.com/KnnJtUom)
 2. 进入[云开发控制台](https://console.cloud.tencent.com/tcb/)，新建环境，请按需配置环境<br>
 ::: tip 提示
+* 推荐创建上海环境。如选择广州环境，需要在 `twikoo.init()` 时额外指定环境 `region: "ap-guangzhou"`
 * 环境名称自由填写
 * 推荐选择计费方式`包年包月`，套餐版本`基础班 1`，超出免费额度不会收费
 * 如果提示选择“应用模板”，请选择“空模板”