From 82b43e0c5b0f0878888317e53a1eb9a0752e4578 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=A6=82=E6=A2=A6=E6=8A=80=E6=9C=AF?= <596392912@qq.com> Date: Wed, 19 May 2021 18:23:03 +0800 Subject: [PATCH] =?UTF-8?q?:memo:=20=E4=BC=98=E5=8C=96=20README.md?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4c1781aa..b9b60195 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -## :tada: mica（云母） +## 🌐 mica（云母） [![Java CI](https://github.com/lets-mica/mica/workflows/Java%20CI/badge.svg)](https://github.com/lets-mica/mica/actions) ![JAVA 8](https://img.shields.io/badge/JDK-1.8+-brightgreen.svg) [![Mica Maven release](https://img.shields.io/nexus/r/https/oss.sonatype.org/net.dreamlu/mica-bom.svg?style=flat-square)](https://mvnrepository.com/artifact/net.dreamlu/mica-bom) @@ -8,25 +8,25 @@ `Mica`，Spring Cloud 微服务开发核心包，支持 `web` 和 `webflux`。 -## :bookmark: 版本说明 +## 🔖 版本说明 | 最新版本 | mica 版本 | spring boot 版本 | spring cloud 版本 | | ----------- | ---------------- | ---------------- | ----------------- | | 2.4.5 | mica 2.4.x | 2.4.x | 2020 | | 2.1.1-GA | mica 2.0.x~2.1.x | 2.2.x ~ 2.3.x | Hoxton | -## :label: 版本号说明 +## 🏷️ 版本号说明 `release` 版本号格式为 `x.x.x`， 基本上保持跟 `Spring boot` 一致。 `snapshots` 版本号格式为 `x.x.x-SNAPSHOT`。 `注意`：`snapshots` 版本 `push` 后会自动发布，及时响应修复最新的 `bug` 和需求。 -## :memo: 使用文档 +## 📝 使用文档 **使用文档**详见：[http://wiki.dreamlu.net（mica2.x 使用文档）](http://wiki.dreamlu.net/guide/getting-started.html) **更新记录**详见：[Mica 更新记录](CHANGELOG.md) -## :white_check_mark: mica 生态 +## 🌱 mica 生态 - mica-auto (Spring boot starter 利器): https://gitee.com/596392912/mica-auto - mica-weixin（jfinal weixin 的 spring boot starter）: https://gitee.com/596392912/mica-weixin - mica-mqtt（基于 t-io 实现的 mqtt组件）: https://gitee.com/596392912/mica-mqtt @@ -35,26 +35,26 @@ ![mica 2.x 模块图](docs/img/mica2.x-open.jpg) -## :bug: 已知问题 +## 🐛 已知问题 lombok 生成的 method 问题：https://github.com/rzwitserloot/lombok/issues/1861 对于 xX 类属性名，第一个小写，第二个大写的 bean 属性名，Map -> Bean 或 Bean -> Map 存在问题。 不打算做兼容，待 lombok 新版修复。 -## :pushpin: 开源协议 +## 📌 开源协议 ![LGPL v3](docs/img/lgplv3-147x51.png) **软著编号**：`2020SR0411603` -## :page_facing_up: 协议解释 +## 📄 协议解释 LGPL（[GNU Lesser General Public License](http://www.gnu.org/licenses/lgpl.html)） LGPL 是 GPL 的一个为主要为类库使用设计的开源协议。和 GPL 要求任何使用/修改/衍生之 GPL 类库的的软件必须采用 GPL 协议不同。LGPL 允许商业软件通过类库引用(link)方式使用 LGPL 类库而不需要开源商业软件的代码。这使得采用 LGPL 协议的开源代码可以被商业软件作为类库引用并发布和销售。 但是如果修改 LGPL 协议的代码或者衍生，则所有修改的代码，涉及修改部分的额外代码和衍生的代码都必须采用 LGPL 协议。因此 LGPL 协议的开源代码很适合作为第三方类库被商业软件引用，但不适合希望以 LGPL 协议代码为基础，通过修改和衍生的方式做二次开发的商业软件采用。 -## :seedling: 用户权益 +## ✅ 用户权益 允许以引入不改源码的形式免费用于学习、毕设、公司项目、私活等。 特殊情况修改代码，但仍然想闭源需经过作者同意。 @@ -65,18 +65,18 @@ LGPL 是 GPL 的一个为主要为类库使用设计的开源协议。和 GPL `注意`：若禁止条款被发现有权追讨 **19999** 的授权费。 -## :card_file_box: 授权用户（最佳实践） +## 🗃️ 授权用户（最佳实践） - `pigx` 宇宙最强微服务（架构师必备）：https://pig4cloud.com - `bladex` 完整的线上解决方案（企业生产必备）：https://bladex.vip -## :mag: 相关链接 +## 🔍️ 相关链接 - mica 源码 Github：[https://github.com/lets-mica](https://github.com/lets-mica) - mica 源码 Gitee（码云）：[https://gitee.com/596392912/mica](https://gitee.com/596392912/mica) - mica 性能压测：[https://github.com/lets-mica/mica-jmh](https://github.com/lets-mica/mica-jmh) - 文档地址（官网）：[http://wiki.dreamlu.net](http://wiki.dreamlu.net/guide/getting-started.html) - 文档地址（语雀-可关注订阅）：[https://www.yuque.com/dreamlu](https://www.yuque.com/dreamlu) -## :beers: 开源推荐 +## 🍻 开源推荐 - `Avue` 一款基于 vue 可配置化的神奇框架：[https://gitee.com/smallweigit/avue](https://gitee.com/smallweigit/avue) - `pig` 宇宙最强微服务（架构师必备）：[https://gitee.com/log4j/pig](https://gitee.com/log4j/pig) - `SpringBlade` 完整的线上解决方案（企业开发必备）：[https://gitee.com/smallc/SpringBlade](https://gitee.com/smallc/SpringBlade) @@ -84,20 +84,20 @@ LGPL 是 GPL 的一个为主要为类库使用设计的开源协议。和 GPL - `JustAuth` 史上最全的整合第三方登录的开源库: [https://github.com/zhangyd-c/JustAuth](https://github.com/zhangyd-c/JustAuth) - `spring-boot-demo` 深度学习并实战 spring boot 的项目: [https://github.com/xkcoding/spring-boot-demo](https://github.com/xkcoding/spring-boot-demo) -## :green_heart: 鸣谢 +## 💚 鸣谢 感谢 JetBrains 提供的免费开源 License： [![JetBrains](docs/img/jetbrains.png)](https://www.jetbrains.com/?from=mica) 感谢 `如梦技术 VIP` **小伙伴们**的鼎力支持，更多 **VIP** 信息详见：https://www.dreamlu.net/vip/index.html -## :iphone: 微信公众号 +## 📱 微信公众号 ![如梦技术](docs/img/dreamlu-weixin.jpg) 精彩内容每日推荐！！！ -## :building_construction: 贡献者 +## 🏗️ 贡献者 ![contributors](https://whnb.wang/contributors/596392912/mica) ![Stargazers over time](https://whnb.wang/img/596392912/mica) -- GitLab