diff --git a/README.md b/README.md index 7c6a062..75ae493 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,63 @@ 本项目基于springboot进行开发,实现了一系列的spring-boot-starter,可以作为开发中的工具包进行使用。 + + ### 模块划分 - common-spring-boot-starter:常用的基础类,比如用作消息流转的`Msg`以及一些工具类 - monitor-spring-boot-starter:监控工具包,可以实现定时监控某些数据并在触发条件后实时通知 - network-spring-boot-starter:网络工具,实现了一系列http请求发送方法,引入后即可快速发送http请求 -- notify-spring-boot-starter:通知工具,集成了邮件通知、短信通知等功能 \ No newline at end of file +- notify-spring-boot-starter:通知工具,集成了邮件通知、短信通知等功能 + + + +## 快速开始 + +### 1. 引入maven依赖 + +本项目已经上传到中央仓库,使用时在pom文件中添加如下依赖即可: + +- network-spring-boot-starter + +```xml + + + com.hxuanyu + network-spring-boot-starter + 1.0.1 + +``` + +- notify-spring-boot-starter + +```xml + + + com.hxuanyu + notify-spring-boot-starter + 1.0.1 + +``` + +- monitor-spring-boot-starter + +```xml + + + com.hxuanyu + monitor-spring-boot-starter + 1.0.1 + +``` + +- monitor-spring-boot-starter + +```xml + + + com.hxuanyu + monitor-spring-boot-starter + 1.0.1 + +``` \ No newline at end of file