diff --git a/README.en-US.md b/README.en-US.md index 39ac774afcdce7998ee9e3f655e6c5eab9317e72..c5d4dd12c21c9f5e78da936e2155646cdede5781 100644 --- a/README.en-US.md +++ b/README.en-US.md @@ -6,7 +6,7 @@

- + @@ -15,7 +15,7 @@ - + @@ -97,7 +97,7 @@ These artifacts are available from Maven Central: me.zhyd.oauth JustAuth - 1.15.7 + 1.15.7-beta.1 ``` - Using JustAuth diff --git a/README.md b/README.md index 7182b97c381f2a8f1cd1fa208b4548dd3f42db20..d06e035323f6d5a99d72610cbb312d5d6fbd1ea9 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

- + @@ -15,7 +15,7 @@ - + @@ -73,22 +73,32 @@

查看更多
- ------------------------------------------------------------------------------- +QQ 群:230017570 +微信群:justauth (备注`justauth`或者`ja`) +帮助文档:[justauth.wiki](https://justauth.wiki) -JustAuth,如你所见,它仅仅是一个**第三方授权登录**的**工具类库**,它可以让我们脱离繁琐的第三方登录SDK,让登录变得**So easy!** +## 什么是 JustAuth? -项目开源地址:[gitee](https://gitee.com/yadong.zhang/JustAuth) | [github](https://github.com/zhangyd-c/JustAuth) -项目文档:[参考文档](https://justauth.wiki) +JustAuth,如你所见,它仅仅是一个**第三方授权登录**的**工具类库**,它可以让我们脱离繁琐的第三方登录 SDK,让登录变得**So easy!** -## 特点 +JustAuth 集成了诸如:Github、Gitee、支付宝、新浪微博、微信、Google、Facebook、Twitter、StackOverflow等国内外数十家第三方平台。更多请参考已集成的平台 -废话不多说,就俩字: +## 有哪些特点? 1. **全**:已集成十多家第三方平台(国内外常用的基本都已包含),仍然还在持续扩展中([开发计划](https://gitee.com/yadong.zhang/JustAuth/issues/IUGRK))! 2. **简**:API就是奔着最简单去设计的(见后面`快速开始`),尽量让您用起来没有障碍感! +## 有哪些功能? + +- 集成国内外数十家第三方平台,实现快速接入。参考文档 +- 自定义 State 缓存,支持各种分布式缓存组件。参考文档 +- 自定义 OAuth 平台,更容易适配自有的 OAuth 服务。参考文档 +- 自定义 Http 实现,选择权完全交给开发者,不会单独依赖某一具体实现。参考文档 +- 自定义 Scope,支持更完善的授权体系。参考文档 +- 更多...参考文档 + ## 快速开始 - 引入依赖 @@ -96,7 +106,7 @@ JustAuth,如你所见,它仅仅是一个**第三方授权登录**的**工具 me.zhyd.oauth JustAuth - 1.15.7 + 1.15.7-beta.1 ``` - 调用api @@ -114,7 +124,7 @@ authRequest.authorize("state"); authRequest.login(callback); ``` -如下**任选一种** HTTP 工具 依赖,_项目内如果已有,请忽略_ +如下**任选一种** HTTP 工具 依赖,_项目内如果已有,请忽略。另外需要特别注意,如果项目中已经引入了低版本的依赖,请先排除低版本以后来,引入高版本或者最新版本的依赖_ - hutool-http @@ -146,62 +156,28 @@ authRequest.login(callback); ``` -## 后续开发计划 - -参考:[[开发计划] 待扩展的第三方平台](https://gitee.com/yadong.zhang/JustAuth/issues/IUGRK) - -另外,期待您和我一起完善这个项目! - -## 贡献代码 +## JustAuth 的用户 +有很多公司、组织和个人把 JustAuth 用于学习、研究、生产环境和商业产品中,包括(但不限于): +![](docs/users/4ca0177c.png) -1. fork本项目到自己的repo -2. 把fork过去的项目也就是你仓库中的项目clone到你的本地 -3. 修改代码 -4. commit后push到自己的库 -5. 发起PR(pull request) 请求,提交到`dev`分支 -6. 等待作者合并 -## 贡献者名单 - -[contributors](https://justauth.wiki/#/contributors) - -## 更新记录 - -[CHANGELOGS](https://justauth.wiki/#/update) - -## 致谢 - -在项目立项初期,也对当前开源圈的一些相同类型的项目作过调研,同时本项目也参考过这些项目,再次感谢开源圈内的朋友。 - -- [YurunOAuthLogin](https://gitee.com/yurunsoft/YurunOAuthLogin): PHP 第三方登录授权 SDK -- [阿里妈妈MUX倾力打造的矢量图标库-iconfont](https://www.iconfont.cn/search/index): 本文档中的图标大部分取自该平台 -- [mica](https://github.com/lets-mica/mica):Spring Cloud 微服务开发核心包,支持 `web `和 `webflux`。注:JustAuth项目中的[UuidUtils](https://gitee.com/yadong.zhang/JustAuth/blob/master/src/main/java/me/zhyd/oauth/utils/UuidUtils.java)就是直接使用的mica提供的高性能的uuid创建工具类源码[StringUtil.java](https://github.com/lets-mica/mica/blob/master/mica-core/src/main/java/net/dreamlu/mica/core/utils/StringUtil.java#L335) -- 感谢 JetBrains 提供的免费开源 License: -图片引用自lets-mica - -JustAuth - Login, so easy! | Product Hunt Embed +怎么没有我?[加入]() ## 开源推荐 - `spring-boot-demo` 深度学习并实战 spring boot 的项目: [https://github.com/xkcoding/spring-boot-demo](https://github.com/xkcoding/spring-boot-demo) - `mica` SpringBoot 微服务高效开发工具集: [https://github.com/lets-mica/mica](https://github.com/lets-mica/mica) -- `pig` 宇宙最强微服务认证授权脚手架(架构师必备): [https://gitee.com/log4j/pig](https://gitee.com/log4j/pig) +- `pig` 微服务认证授权脚手架(架构师必备): [https://gitee.com/log4j/pig](https://gitee.com/log4j/pig) - `SpringBlade` 完整的线上解决方案(企业开发必备): [https://gitee.com/smallc/SpringBlade](https://gitee.com/smallc/SpringBlade) - `MaxKey` 马克思的钥匙,寓意是最大钥匙,是用户单点登录认证系统(Sigle Sign On System),OAuth 2.0/OpenID Connect、SAML 2.0、JWT、CAS等标准化的开放协议,使用JustAuth集成OAuth第三方认证。: [https://shimingxy.github.io/MaxKey/](https://shimingxy.github.io/MaxKey/) +- `YurunOAuthLogin` PHP 第三方登录授权 SDK:[YurunOAuthLogin](https://gitee.com/yurunsoft/YurunOAuthLogin) -## 关注&交流 - -| 公众号 | 微信(备注:JustAuth) | -| :------------: | :------------: | -| | | - - **QQ群** - -- JustAuth交流群 (230017570):专业交流该项目 - -## 请喝咖啡 +# 鸣谢 +- 感谢 JetBrains 提供的免费开源 License: +图片引用自lets-mica -| 支付宝 | 微信 | -| :------------: | :------------: | -| | | +JustAuth - Login, so easy! | Product Hunt Embed -通过“[爱发电](https://afdian.net/@zhangyadong)”赞助,感谢您的支持 \ No newline at end of file +## 其他 +- [CONTRIBUTORS](https://justauth.wiki/#/contributors) +- [CHANGELOGS](https://justauth.wiki/#/update) +- [PLAN](https://gitee.com/yadong.zhang/JustAuth/issues/IUGRK) \ No newline at end of file diff --git a/bin/version.txt b/bin/version.txt index 545fd574d35bc56aff646af7f139af4e25ec3e85..9ada69bb4ef98588be3863d661e5b0c17484b19b 100644 --- a/bin/version.txt +++ b/bin/version.txt @@ -1 +1 @@ -1.15.7 +1.15.7-beta.1 diff --git a/docs/users/4ca0177c.png b/docs/users/4ca0177c.png new file mode 100644 index 0000000000000000000000000000000000000000..cef00d569b593b1a98b93b7240ef7189abffbba0 Binary files /dev/null and b/docs/users/4ca0177c.png differ diff --git a/pom.xml b/pom.xml index 76a456025059e2acf852ee0ac9c4914b040b2dce..3dd00bc83e6c531f289baee5ad21331e485b4b74 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ me.zhyd.oauth JustAuth - 1.15.7 + 1.15.7-beta.1 JustAuth https://gitee.com/yadong.zhang/JustAuth