From ce1e0183c7df4b8823abda869aebc0547d2d31b2 Mon Sep 17 00:00:00 2001 From: wixy Date: Wed, 15 Jun 2022 23:56:12 +0800 Subject: [PATCH] modify doc for v2.0.0 --- docs/guide/README.md | 28 +++++++++++++++++++++++----- docs/guide/advanced/oauth.md | 2 +- docs/subscribe.md | 6 +++++- 3 files changed, 29 insertions(+), 7 deletions(-) diff --git a/docs/guide/README.md b/docs/guide/README.md index 108b47f..aa17f7e 100644 --- a/docs/guide/README.md +++ b/docs/guide/README.md @@ -1,18 +1,36 @@ # 接入指南 -## #方式一(简单) +## #微信小程序扫码登陆 -> 前端点击微信扫码登录按钮跳转到QuickAuth扫码登录界面(或者弹出扫码登录窗口),用户扫码完成后重定向到开发者配置的回调地址并携带相应的参数 +> 通过微信扫码打开小程序完成授权登录的操作 #### 特点 +- 接入永久免费 - 接入流程简单快捷 - Typecho和WordPress可以直接使用插件,无代码接入 +- - [查看详情](/guide/method1/) + [详细接口文档](/guide/free/) + [Typecho接入教程](https://gitee.com/wixy/QuickAuthLogin) + [WordPress接入教程](https://gitee.com/wixy/QuickAuthLogin-WP) -## #方式二(高级) +## #高级订阅接口接入 + +> 通过微信扫码打开H5页面完成授权登录的操作,支持微信内静默授权,支持QQ、Github、Gitee等授权登录方式 + +#### 特点 + +- 微信H5授权无需打开小程序,直接完成授权 +- 支持微信客户端内实现无感登录 +- 支持QQ、Github、Gitee等授权登录方式 + + [详细接口文档](/guide/advanced/) + [Typecho接入教程(高级版插件正在开发中)](https://gitee.com/wixy/QuickAuthLogin) + [WordPress接入教程(高级版插件正在开发中)](https://gitee.com/wixy/QuickAuthLogin-WP) + +## #复杂授权方式 > 开发者通过接口获取二维码并展示,用户扫码授权完成后QuickAuth向开发者配置的回调地址发起授权请求并传入用户信息,开发者根据调用参数和回传参数识别用户登录情况 @@ -21,4 +39,4 @@ - 可自行获取二维码,自定义登录界面及流程 - 自定义程度高 - [查看详情](/guide/method2/) \ No newline at end of file + [详细接口文档](/guide/archived/) \ No newline at end of file diff --git a/docs/guide/advanced/oauth.md b/docs/guide/advanced/oauth.md index 1c08bd2..7cdceee 100644 --- a/docs/guide/advanced/oauth.md +++ b/docs/guide/advanced/oauth.md @@ -16,7 +16,7 @@ |appkey|是|开发者在QuickAuth网站创建应用的AppKey| |state|是|开发者应用附加信息| -#### 备注 +##### 备注 type参数传wechat时,如果是在微信客户端内打开网站,则不需要扫码,直接完成静默授权逻辑,实现无感登录 #### 4、重定向时携带的参数 diff --git a/docs/subscribe.md b/docs/subscribe.md index af4361b..d893fa9 100644 --- a/docs/subscribe.md +++ b/docs/subscribe.md @@ -1,4 +1,8 @@ -## 普通用户及订阅会员的功能说明 +## 订阅说明 + +用户首次登录QuickAuth系统即可获赠30天的订阅会员 + +#### 普通用户及订阅会员的功能说明 | 功能 | 普通用户 | 订阅会员 | | ---------------------------- | -------- | -------- |