Optimize the description in the README.md

hellooo-stack · Feb 10, 2023 · 43904ec · 43904ec
1 parent 880ac6a
commit 43904ec
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,13 +1,15 @@
 # DistributedLock
 
-[![Maven Central](https://img.shields.io/maven-central/v/site.hellooo/hellooo-distributedlock)](https://img.shields.io/maven-central/v/site.hellooo/hellooo-distributedlock)
-[![GitHub license](https://img.shields.io/github/license/hellooo-stack/hellooo-distributedlock)](https://img.shields.io/github/license/hellooo-stack/hellooo-distributedlock)
+![Build](https://img.shields.io/github/actions/workflow/status/hellooo-stack/hellooo-distributedlock/maven.yml)
+![Code Size](https://img.shields.io/github/languages/code-size/hellooo-stack/hellooo-distributedlock)
+![Maven Central](https://img.shields.io/maven-central/v/site.hellooo/hellooo-distributedlock)
+![GitHub license](https://img.shields.io/github/license/hellooo-stack/hellooo-distributedlock)
 
 DistributedLock is a lightweight distributed lock framework that provides reliable consistency features. It can be used with only the Lock interface.
 
 
 # Features
-- Reentrant locking
+- Reentrant distributed locking
 - Supports tryLock(), lock(), unlock() operations
 - Supports lock leasing
 
@@ -21,7 +23,7 @@ Step one: Add maven dependency
 </dependency>
 ```
 
-Step two: Add customize configuration by annotation
+Step two: lock your resources with Lock.lock()
 ```java
 public class Main {
     public static void main(String[] args) {

diff --git a/pom.xml b/pom.xml
@@ -7,11 +7,13 @@
     <version>0.0.5-GA</version>
 
     <properties>
-<!--         <project.build.sourceEncoding>UTF8</project.build.sourceEncodin> -->
         <project.build.sourceEncoding>UTF8</project.build.sourceEncoding>
         <maven.compiler.source>8</maven.compiler.source>
         <maven.compiler.target>8</maven.compiler.target>
         <jedis.version>4.2.3</jedis.version>
+        <junit.version>4.13.2</junit.version>
+        <assertj-core.version>3.23.1</assertj-core.version>
+        <mockito-core.version>4.6.1</mockito-core.version>
     </properties>
     <dependencies>
         <dependency>
@@ -24,18 +26,18 @@
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>4.13.2</version>
-            <scope>test</scope>
+            <scope>${junit.version}</scope>
         </dependency>
         <dependency>
             <groupId>org.assertj</groupId>
             <artifactId>assertj-core</artifactId>
-            <version>3.23.1</version>
+            <version>${assertj-core.version}</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.mockito</groupId>
             <artifactId>mockito-core</artifactId>
-            <version>4.6.1</version>
+            <version>${mockito-core.version}</version>
             <scope>test</scope>
         </dependency>
     </dependencies>