Skip to content

Commit 434fc0a

Browse files
authored
feat(README): polish and add new Matrix chat link (#248)
1 parent 6740287 commit 434fc0a

1 file changed

Lines changed: 29 additions & 27 deletions

File tree

README.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,36 @@
4545
<img alt="GitHub license"
4646
src="https://img.shields.io/github/license/eventually-rs/eventually-rs?style=flat-square">
4747
</a>
48+
<!-- Matrix -->
49+
<a href="https://matrix.to/#/#get-eventually:matrix.org">
50+
<img alt="Matrix Chat"
51+
src="https://img.shields.io/matrix/get-eventually:matrix.org?logo=matrix&style=flat-square">
52+
</a>
4853
</div>
4954

5055
<br />
5156

5257

5358
Collection of traits and other utilities to help you build your Event-sourced applications in Rust.
5459

55-
> :warning: **version 0.5.0 is under active develoment**: Breaking changes are expected. If you are using `Eventually` as a git dependency you should use a pinned version.
60+
## Installation
61+
62+
> ⚠️ **v0.5.0 is under active development**: Breaking changes are expected. If you are using `eventually` as a git dependency you should use a pinned version!
63+
64+
Add `eventually` into your project dependencies:
65+
66+
```toml
67+
[dependencies]
68+
eventually = { version = "0.5.0", features = ["full"], git = "https://github.com/get-eventually/eventually-rs" }
69+
```
70+
71+
### Note on semantic versioning
72+
73+
This library is **actively being developed**, and prior to `v1` release the following [Semantic versioning]()
74+
is being adopted:
75+
76+
* Breaking changes are tagged with a new `MINOR` release
77+
* New features, patches and documentation are tagged with a new `PATCH` release
5678

5779
## What is Event Sourcing?
5880

@@ -62,7 +84,7 @@ From [eventstore.com](https://eventstore.com/) introduction:
6284

6385
>Event Sourcing is an architectural pattern that is gaining popularity as a method for building modern systems. Unlike traditional databases which only store and update the current state of data, event-sourced systems store all changes as an immutable series of events in the order that they occurred and current state is derived from that event log.
6486
65-
## How does `eventually` support Event Sourcing?
87+
## How does `eventually-rs` support Event Sourcing?
6688

6789
`eventually` exposes all the necessary abstraction to model your
6890
Domain Entities (in lingo, _Aggregates_) using Domain Events, and
@@ -73,40 +95,20 @@ For more information, [check out the crate documentation](https://docs.rs/eventu
7395
You can also take a look at the [`bank-accounting`](https://github.com/get-eventually/eventually-rs/tree/main/examples/bank-accounting) example,
7496
showcasing Event-sourced application for a generic (and simple) Bank Accounting bounded context.
7597

76-
All other questions are more than welcome on our [Gitter chat](https://gitter.im/eventually-rs/community).
77-
7898
### Event Store backends
7999

80-
`eventually` provides the necessary abstractions for modeling and interacting
100+
`eventually-rs` provides the necessary abstractions for modeling and interacting
81101
with an Event Store.
82102

83103
These are the following officially-supported backend implementations:
84-
* [`eventually::inmemory::EventStore`](): simple inmemory Event Store implementation, using `std::collections::HashMap`,
85-
* [`eventually-postgres`](./eventually-postgres): Event Store implementation for PostgreSQL databases,
86-
* [`eventually-redis`](./eventually-redis): Event Store implementation for Redis stores.
87-
88-
## Installation
89-
90-
Add `eventually` into your project dependencies:
91-
92-
```toml
93-
[dependencies]
94-
eventually = { version = "0.4.0", features = ["full"] }
95-
```
96-
97-
### Note on semantic versioning
98-
99-
This library is **actively being developed**, and prior to `v1` release the following [Semantic versioning]()
100-
is being adopted:
101-
102-
* Breaking changes are tagged with a new `MINOR` release
103-
* New features, patches and documentation are tagged with a new `PATCH` release
104+
* [`eventually::event::store::InMemory`](./eventually/src/event/store.rs): simple inmemory Event Store implementation, using `std::collections::HashMap`,
105+
* [`eventually-postgres`](./eventually-postgres): Event Store and Aggregate Root Repository implementations for PostgreSQL databases.
104106

105107
## Contributing
106108

107-
You want to contribute to `eventually` but you don't know where to start?
109+
You want to contribute to `eventually-rs` but you don't know where to start?
108110

109-
First of all, thank you for considering contributing :heart:
111+
First of all, thank you for considering contributing ❤️
110112

111113
You can head over our [`CONTRIBUTING`](./CONTRIBUTING.md) section to know
112114
how to contribute to the project, and — in case you don't have a clear idea what

0 commit comments

Comments
 (0)