diff --git a/README.md b/README.md index c3fa830..d4a9b58 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,27 @@ # BuzhouKit -##### An idempotent component -##### 一个简单的幂等组件库 +##### A Lightweight Idempotent Component +##### 轻量级幂等组件库 > ##### *西北海之外,大荒之隅,有山而不合,名曰不周负子,有两黄兽守之。有水曰寒署之水。水西有湿山,水东有幕山。* > #####
—— 《山海经》海经·大荒西经
## 项目概述 **BuzhouKit** 是一款专为确保幂等性设计的组件库。此库适用于需要保证操作重复性和一致性的应用场景,为开发者提供一个可靠、稳定的基础设施。 +### 配置/如何使用 +### 1,代码配置 +##### 方法一(将代码配置到本地maven仓库) +1,将代码克隆/下载到本地 +2,在BuZhouKit\BuZhouKit-Idempotent>目录下运行`mvn clean install` +##### 方法二(推荐,将代码作为你的项目的一个模块来使用) +1,将代码克隆/下载到本地 +2,将代码copy到项目某模块中 +### 2,组件使用 +简而言之就是在需要实现幂等的方法上添加幂等注解@Idempotent,再配置所需的参数。 +下面主要讲解核心参数的含义与使用: +1, + +### 参数类型选择 +1,缓存类型选择:1,基于caffeine组件的本地缓存;2,基于redis的分布式缓存 +