Skip to content

Commit

Permalink
docs: cleanup readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Tochemey committed Dec 27, 2024
1 parent 2383cf2 commit 08e6199
Showing 1 changed file with 7 additions and 26 deletions.
33 changes: 7 additions & 26 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ reliable persistence.
- [Mocks](#mocks)
- [Examples](#examples)
- [Sample](#sample)
- [Contribution](#contribution)

## Installation

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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)

0 comments on commit 08e6199

Please sign in to comment.