Skip to content

Commit 43904ec

Browse files
committed
Optimize the description in the README.md
1 parent 880ac6a commit 43904ec

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# DistributedLock
22

3-
[![Maven Central](https://img.shields.io/maven-central/v/site.hellooo/hellooo-distributedlock)](https://img.shields.io/maven-central/v/site.hellooo/hellooo-distributedlock)
4-
[![GitHub license](https://img.shields.io/github/license/hellooo-stack/hellooo-distributedlock)](https://img.shields.io/github/license/hellooo-stack/hellooo-distributedlock)
3+
![Build](https://img.shields.io/github/actions/workflow/status/hellooo-stack/hellooo-distributedlock/maven.yml)
4+
![Code Size](https://img.shields.io/github/languages/code-size/hellooo-stack/hellooo-distributedlock)
5+
![Maven Central](https://img.shields.io/maven-central/v/site.hellooo/hellooo-distributedlock)
6+
![GitHub license](https://img.shields.io/github/license/hellooo-stack/hellooo-distributedlock)
57

68
DistributedLock is a lightweight distributed lock framework that provides reliable consistency features. It can be used with only the Lock interface.
79

810

911
# Features
10-
- Reentrant locking
12+
- Reentrant distributed locking
1113
- Supports tryLock(), lock(), unlock() operations
1214
- Supports lock leasing
1315

@@ -21,7 +23,7 @@ Step one: Add maven dependency
2123
</dependency>
2224
```
2325

24-
Step two: Add customize configuration by annotation
26+
Step two: lock your resources with Lock.lock()
2527
```java
2628
public class Main {
2729
public static void main(String[] args) {

pom.xml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,13 @@
77
<version>0.0.5-GA</version>
88

99
<properties>
10-
<!-- <project.build.sourceEncoding>UTF8</project.build.sourceEncodin> -->
1110
<project.build.sourceEncoding>UTF8</project.build.sourceEncoding>
1211
<maven.compiler.source>8</maven.compiler.source>
1312
<maven.compiler.target>8</maven.compiler.target>
1413
<jedis.version>4.2.3</jedis.version>
14+
<junit.version>4.13.2</junit.version>
15+
<assertj-core.version>3.23.1</assertj-core.version>
16+
<mockito-core.version>4.6.1</mockito-core.version>
1517
</properties>
1618
<dependencies>
1719
<dependency>
@@ -24,18 +26,18 @@
2426
<groupId>junit</groupId>
2527
<artifactId>junit</artifactId>
2628
<version>4.13.2</version>
27-
<scope>test</scope>
29+
<scope>${junit.version}</scope>
2830
</dependency>
2931
<dependency>
3032
<groupId>org.assertj</groupId>
3133
<artifactId>assertj-core</artifactId>
32-
<version>3.23.1</version>
34+
<version>${assertj-core.version}</version>
3335
<scope>test</scope>
3436
</dependency>
3537
<dependency>
3638
<groupId>org.mockito</groupId>
3739
<artifactId>mockito-core</artifactId>
38-
<version>4.6.1</version>
40+
<version>${mockito-core.version}</version>
3941
<scope>test</scope>
4042
</dependency>
4143
</dependencies>

0 commit comments

Comments
 (0)