From 08e61996cf8af697f870da504a59cc97c1f77663 Mon Sep 17 00:00:00 2001
From: Tochemey <tochemey@hotmail.com>
Date: Fri, 27 Dec 2024 16:22:19 +0000
Subject: [PATCH] docs: cleanup readme

---
 readme.md | 33 +++++++--------------------------
 1 file changed, 7 insertions(+), 26 deletions(-)

diff --git a/readme.md b/readme.md
index 4143e0e..25875f9 100644
--- a/readme.md
+++ b/readme.md
@@ -32,6 +32,7 @@ reliable persistence.
 - [Mocks](#mocks)
 - [Examples](#examples)
 - [Sample](#sample)
+- [Contribution](#contribution)
 
 ## Installation
 
@@ -164,15 +165,16 @@ the [DurableState](./protos/ego/v3/ego.proto).
 
 ## Cluster
 
-The cluster mode heavily relies on [Go-Akt](https://github.com/Tochemey/goakt#clustering) clustering.
+The cluster mode heavily relies on [Go-Akt](https://github.com/Tochemey/goakt#clustering) clustering. To enable clustering one need to use `WithCluster` option
+when creating the eGo engine.
 
 ## Testkit
 
-eGo comes bundle with in-memory datastore that can be found in the [testkit](./testkit) package. This can help play with eGo
+eGo comes bundle with in-memory datastore that can be found in the [testkit](./testkit) package. This can help play with eGo.
 
 ## Mocks
 
-eGo ships in some [mocks](./mocks)
+eGo ships in some [mocks](./mocks) that can help mock the data stores for unit tests purpose.
 
 ## Examples
 
@@ -325,27 +327,6 @@ func (a *AccountBehavior) HandleEvent(_ context.Context, event ego.Event, priorS
 
 ```
 
-### Contribution
+## Contribution
 
-Contributions are welcome!
-The project adheres to [Semantic Versioning](https://semver.org)
-and [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/).
-This repo uses [Earthly](https://earthly.dev/get-earthly).
-
-There are two ways you can become a contributor:
-
-1. Request to become a collaborator, and then you can just open pull requests against the repository without forking it.
-2. Follow these steps
-
-- Fork the repository
-- Create a feature branch
-- Set your docker credentials on your fork using the following secret names: `DOCKER_USER` and `DOCKER_PASS`
-- Submit a [pull request](https://help.github.com/articles/using-pull-requests)
-
-## Test & Linter
-
-Prior to submitting a [pull request](https://help.github.com/articles/using-pull-requests), please run:
-
-```bash
-earthly +test
-```
+kindly follow the instructions in the [contribution doc](./contributing.md)