diff --git a/README.md b/README.md index 4b6db87..0f678c7 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -## 常见问题 -[https://day.app/2021/06/barkfaq/](https://day.app/2021/06/barkfaq/) +## 使用文档 +[https://bark.day.app](https://bark.day.app) ## 问题反馈 Telegram 群 [Bark反馈群](https://t.me/joinchat/OsCbLzovUAE0YjY1) diff --git a/docs/README.md b/docs/README.md index b324c71..b383fb8 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,11 +3,11 @@ - 免费、轻量!简单调用接口即可给自己的iPhone发送推送。 - 依赖苹果APNs,及时、稳定、可靠 - 不会消耗设备的电量, 基于系统推送服务与推送扩展,APP本体并不需要运行。 -- 信任成本很昂贵,所以 Bark 默认所有人(包含作者本人)都有可能窃取你的隐私,以此为基础来设计隐私保护。
*点击详细了解Bark如果保障[隐私安全](/privacy)* +- 信任成本很昂贵,所以 Bark 默认所有人(包含作者本人)都有可能窃取你的隐私,以此为基础来设计隐私保护。
*点击详细了解Bark如何保障[隐私安全](/privacy)* ### 源码 - [Bark](https://github.com/Finb/Bark) 是完整开源的 iOS APP,用来接收自定义推送。 -- [bark-server](https://github.com/Finb/bark-server) 是完整开源的 Bark 服务后端,用来接收用户的推送并转发给苹果APNS。 +- [bark-server](https://github.com/Finb/bark-server) 是完整开源的 Bark 服务后端,用来接收用户的推送请求并转发给苹果APNS。 ### 反馈 - [Bark 问题反馈群](https://t.me/joinchat/OsCbLzovUAE0YjY1) (注意点击入群验证) @@ -18,7 +18,7 @@ Bark **2018年7月**上线,至少会维持运营到 **2031年7月** 。*(说 APP在维持期间,不会有任何形式的收费与广告,各位彦祖放心使用。 ### 赞助 -目前仅接收 GitHub 赞助,同时非常感谢每一位赞助者
+目前仅接收 GitHub 赞助,同时非常感谢每一位赞助者
赞助者:[https://github.com/sponsors/Finb](https://github.com/sponsors/Finb) ### 文档 diff --git a/docs/en-us/_coverpage.md b/docs/en-us/_coverpage.md index 616983d..1e6a6f4 100755 --- a/docs/en-us/_coverpage.md +++ b/docs/en-us/_coverpage.md @@ -2,7 +2,7 @@ # Bark -> ... +> 欢迎彦祖们提交PR完善英文文档 - ... - ... diff --git a/docs/faq.md b/docs/faq.md index 6218dc5..ba17dd9 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -39,9 +39,8 @@ Bark支持 GET POST ,支持使用Json
# 应该将 {推送内容} url编码后再进行拼接 https://api.day.app/key/a%2Fb%2Fc%2F ``` - - 如果是使用成熟的HTTP库时,参数都会被自动处理,无需自己手动编码。
- 但如果是自己去拼接URL时,则需要特别注意参数中的特殊字符,最好不管有没有特殊字符,无脑套一层URL编码。 +如果是使用成熟的HTTP库时,参数都会被自动处理,无需自己手动编码。
+但如果是自己去拼接URL时,则需要特别注意参数中的特殊字符,**最好不管有没有特殊字符,无脑套一层URL编码**。 #### 如何保障隐私安全 参考[隐私安全](/privacy) diff --git a/docs/tutorial.md b/docs/tutorial.md index a361097..a94b5fc 100644 --- a/docs/tutorial.md +++ b/docs/tutorial.md @@ -4,10 +4,10 @@ 2. 修改内容,请求这个URL。
-可以发 get 或者 post 请求 ,请求成功会立即收到推送 +可以发 GET 或者 POST 请求 ,请求成功会立即收到推送 ## URL格式 -URL由 推送key、参数 title、参数 body 组成。有下面两种组合方式 +URL由推送key、参数 title、参数 body 组成。有下面两种组合方式 ``` /:key/:body @@ -15,16 +15,18 @@ URL由 推送key、参数 title、参数 body 组成。有下面两种组合方 ``` ## 请求方式 -GET 请求参数拼接在 URL 后面,例如: +##### GET 请求参数拼接在 URL 后面,例如: ```sh curl https://api.day.app/your_key/推送内容?group=分组©=复制 ``` -POST 请求参数放在请求体中,例如: +*手动拼接参数到URL上时,请注意URL编码问题,可以参考阅读[常见问题:URL编码](http://localhost:3000/#/faq?id=%e6%8e%a8%e9%80%81%e7%89%b9%e6%ae%8a%e5%ad%97%e7%ac%a6%e5%af%bc%e8%87%b4%e6%8e%a8%e9%80%81%e5%a4%b1%e8%b4%a5%ef%bc%8c%e6%af%94%e5%a6%82-%e6%8e%a8%e9%80%81%e5%86%85%e5%ae%b9%e5%8c%85%e5%90%ab%e9%93%be%e6%8e%a5%ef%bc%8c%e6%88%96%e6%8e%a8%e9%80%81%e5%bc%82%e5%b8%b8-%e6%af%94%e5%a6%82-%e5%8f%98%e6%88%90%e7%a9%ba%e6%a0%bc)* + +##### POST 请求参数放在请求体中,例如: ```sh curl -X POST https://api.day.app/your_key \ -d'body=推送内容&group=分组©=复制' ``` -POST 请求支持JSON,例如: +##### POST 请求支持JSON,例如: ```sh curl -X "POST" "https://api.day.app/your_key" \ -H 'Content-Type: application/json; charset=utf-8' \ @@ -40,7 +42,7 @@ curl -X "POST" "https://api.day.app/your_key" \ }' ``` -JSON 请求 key 可以放进请求体中,URL 路径须为 /push,例如 +##### JSON 请求 key 可以放进请求体中,URL 路径须为 /push,例如 ```sh curl -X "POST" "https://api.day.app/push" \ -H 'Content-Type: application/json; charset=utf-8' \