update README.md and add workflows

Author: Alpha2J

.github/workflows/maven.yml

@@ -0,0 +1,45 @@
+# This workflow will build a Java project with Maven
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+
+name: Build
+
+on:
+  push:
+    branches-ignore:
+      - '**-alpha'
+      - '**-tmp'
+      - '**-temp'
+  pull_request:
+    branches-ignore:
+      - '**-alpha'
+      - '**-tmp'
+      - '**-temp'
+  workflow_dispatch:
+    inputs:
+      profiles:
+        description: 'mvn -P <arg>'
+        required: false
+        default: ''
+
+jobs:
+  build:
+
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 1.8
+        uses: actions/setup-java@v1
+        with:
+          java-version: 1.8
+      - name: Clean and Package
+        if: github.event.inputs.profiles == ''
+        run: mvn clean package
+      - name: Clean and Package With Profiles
+        if: github.event.inputs.profiles != ''
+        run: mvn -P ${{ github.event.inputs.profiles }} clean package
+      - name: Upload coverage to Codecov
+        if: github.event_name == 'push'
+        uses: codecov/[email protected]
+        with:
+          token: ${{secrets.CODECOV_TOKEN}}

README.md

@@ -1,17 +1,58 @@
-1. memo:
-// 锁的元数据信息
-// 加锁过程的扩展点
-// 解锁过程的扩展点
-// 异常的扩展点
-// 数据源
+# 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)
 
-2. features:
+DistributedLock is a lightweight distributed lock framework that provides reliable consistency features. It can be used with only the Lock interface.
 
 
-3. implemented:
+# Features
+- Reentrant locking
+- Supports tryLock(), lock(), unlock() operations
+- Supports lock leasing
 
-4. test schedule:
+# Quick Start
+Step one: Add maven dependency
+```xml
+<dependency>
+    <groupId>site.hellooo</groupId>
+    <artifactId>hellooo-distributedlock</artifactId>
+    <version>>${hellooo-distributedlock.version}</version>
+</dependency>
+```
 
-5. what problems have I meet
-  - how to test private method: [sloved](https://stackoverflow.com/questions/34571/how-do-i-test-a-class-that-has-private-methods-fields-or-inner-classes)
+Step two: Add customize configuration by annotation
+```java
+public class Main {
+    public static void main(String[] args) {
+        LockOptions lockOptions = LockOptions.options()
+                .build();
+
+//        define the redis source
+        JedisPool pool = new JedisPool("localhost", 6379);
+        for (int i = 0; i < 10; i++) {
+            final int threadNumber = i;
+            Thread thread = new Thread(() -> {
+                Thread.currentThread().setName("Thread " + threadNumber);
+
+                try (Jedis jedis = pool.getResource()) {
+                    try {
+                        Lock lock = new ReentrantDistributedLock(lockOptions, "my_lock", new RedisLockHandler(jedis));
+//                        lock 
+                        lock.lock();
+                        System.out.println("thread" + Thread.currentThread().getName() + " locked!");
+                        Thread.sleep(1000);
+                        System.out.println("thread" + Thread.currentThread().getName() + " lock released!");
+//                        unlock
+                        lock.unlock();
+                    } catch (Exception e) {
+                        e.printStackTrace();
+                    }
+                }
+            });
+            thread.start();
+        }
+    }
+}
+
+```