Add README.md

dethi · Dec 9, 2017 · a7d3f20 · a7d3f20
1 parent 36bb79a
commit a7d3f20
Showing 1 changed file with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,32 @@
+# Guereza 🐒
+
+Guereza is a small example of distributed application design. It uses the following patterns:
+- DDD
+- AOP
+- EventBus
+- Event Sourcing
+- CQRS
+
+Moreover, the project implements the following features:
+- Netty Server and Client
+- Custom Injection Framework
+- Custom Event Sourcing Framework
+
+## Build
+
+Building and running is easy with `gradle`:
+
+```
+$ gradle wrapper
+$ ./gradlew build
+$ java -jar build/libs/guereza-1.0-SNAPSHOT-all.jar
+```
+
+## Usage
+
+There is 4 available modules:
+- server: aggregate and dispatch all events
+- store: store events and let reducers act on them
+- crawler and indexer: request URLs and index the content
+
+You need to start **one** `server` and `store`. Then, you can start as many other modules as you want.