Improve documentation

Author: pmendelski

.github/workflows/docs.yml

@@ -7,7 +7,7 @@ on:
     paths:
       - 'docs/**'
       - 'mkdocs.yml'
-      - 'requirements.txt'
+      - 'mkdocs-requirements.txt'
 
 jobs:
   docs:
@@ -17,5 +17,5 @@ jobs:
       - uses: actions/setup-python@v2
         with:
           python-version: 3.x
-      - run: pip install mkdocs-material -r requirements.txt
+      - run: pip install mkdocs -r mkdocs-requirements.txt
       - run: mkdocs gh-deploy --force

CHANGELOG.md

@@ -2,9 +2,10 @@
 
 ## [Unreleased]
 
-## [0.4.11] - 2021-11-23
+## [0.4.11] - 2021-11-24
 ### Changed
 - Update dependencies
+- Clean up documentation
 
 ## [0.4.10] - 2021-11-23
 ### Changed
@@ -19,7 +20,6 @@
 ### Changed
 - Fix documentation
 
-
 [Unreleased]: https://github.com/coditory/sherlock-distributed-lock/compare/v0.4.11...HEAD
 [0.4.11]: https://github.com/coditory/sherlock-distributed-lock/releases/tag/v0.4.11
 [0.4.10]: https://github.com/coditory/sherlock-distributed-lock/releases/tag/v0.4.10

README.md

@@ -3,12 +3,44 @@
 [![Coverage Status](https://coveralls.io/repos/github/coditory/sherlock-distributed-lock/badge.svg)](https://coveralls.io/github/coditory/sherlock-distributed-lock)
 [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.coditory.sherlock/sherlock-api-sync/badge.svg)](https://search.maven.org/search?q=com.coditory.sherlock)
 [![JavaDoc](http://www.javadoc.io/badge/com.coditory.sherlock/sherlock-api-sync.svg)](http://www.javadoc.io/doc/com.coditory.sherlock/sherlock-api-sync)
-[![Join the chat at https://gitter.im/coditory/sherlock-distributed-lock](https://badges.gitter.im/coditory/sherlock-distributed-lock.svg)](https://gitter.im/coditory/sherlock-distributed-lock?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-## Distributed lock JVM library
+> Distributed lock library for JVM projects
 
-Sherlock Distributed Lock is a JVM library that provides distributed locking mechanism.
-It uses a database to store locks and exposes both synchronous and reactive API.
-It was created as a simple solution to manage distributed locks among multiple microservices.
+Look for details in the [documentation](https://coditory.github.io/sherlock-distributed-lock/).
+
+- **minimal dependency** - the main dependency is database driver that is probably already used in your project
+- **provides different [types of locks](https://coditory.github.io/sherlock-distributed-lock/locs)** - small but flexible
+- **provides [migration capabilities](https://coditory.github.io/sherlock-distributed-lock/migrator)** - no need for another library for database migration process
+- **exposes [synchronous and reactive API](https://coditory.github.io/sherlock-distributed-lock/api)** - changing API should not be a revolution
+
+## Sample usage
+
+Add dependency to `build.gradle`:
+```groovy
+dependencies {
+  compile "com.coditory.sherlock:sherlock-mongo-sync:1.4.10"
+}
+```
+
+Create synchronous MongoDB backed lock:
+```java
+// Get mongo locks collection
+MongoClient mongoClient = MongoClients.create("mongodb://localhost:27017/sherlock");
+MongoCollection<Document> collection = mongoClient
+    .getDatabase("sherlock")
+    .getCollection("locks");
+
+// Create sherlock
+Sherlock sherlock = MongoSherlock.builder()
+    .withLocksCollection(collection)
+    .build();
+
+// Create a lock
+DistributedLock lock = sherlock.createLock("sample-lock");
+
+// Acquire a lock
+lock.acquireAndExecute(() -> {
+    System.out.println("Lock granted!");
+});
+```
 
-For details go to the [documentation](https://coditory.github.io/sherlock-distributed-lock/).

docs/about.md

@@ -0,0 +1,3 @@
+- [GitHub Repository](https://github.com/coditory/sherlock-distributed-lock/)
+- [License](https://github.com/coditory/sherlock-distributed-lock/blob/master/LICENSE)
+- [Changelog](https://github.com/coditory/sherlock-distributed-lock/blob/master/CHANGELOG.md)

docs/about/changelog.md

@@ -0,0 +1,7 @@
+# Sherlock API 
+
+Sherlock exposes synchronous and reactive API in order to fit any code base. Exposed APIs:
+
+- [Synchronous API](synchronous.md) - Synchronous API that uses blocking database connectors
+- [Reactor API](reactor.md) - Reactive API that uses [Reactor](https://projectreactor.io/) and reactive database connectors
+- [RxJava API](rxjava.md) - Reactive API that uses [RxJava (v2)](https://github.com/ReactiveX/RxJava) and reactive database connectors