Skip to content

Commit 1ba06af

Browse files
committed
increment version
1 parent 50d1347 commit 1ba06af

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,30 +4,30 @@
44

55
Supports `Event` and `Snapshot` storage providers like EventStore/Redis or SQL Server. Built with dependency injection in mind and seamlessly integrates with AspNetCore.
66

7-
## Give a star :star: if you appreciate the effort
7+
### Give a star :star: if you appreciate the effort
88

99
## What is Event Sourcing?
1010

1111
> Use an append-only store to record the full series of events that describe actions taken on data in a domain, rather than storing just the current state.
1212
1313
Start here [https://dasith.me/2016/12/02/event-sourcing-examined-part-1-of-3/](https://dasith.me/2016/12/02/event-sourcing-examined-part-1-of-3/)
1414

15-
## What does NEventLite solve? :goal_net:
15+
## :goal_net: What does NEventLite solve?
1616
NEventLite makes it easier to implement the event sourcing pattern in your .NET project. The library is opinionated and introduces some patterns to manage the life cycle of your [Aggregates](https://martinfowler.com/bliki/DDD_Aggregate.html) in an event sourced system. It will manage Creating, Loading, Mutating and Persisting Aggregates and Events.
1717

18-
## What doesn't it solve? :warning:
18+
## :warning: What doesn't it solve?
1919

2020
NEventLite is **not a framework** that manages your application end to end. It doesn't enforce ports and adapters pattern or any of the application level concerns. The aim is to do one thing (Manage aggregate lifecycle) and do that well. If you need to implement command and event handlers you can have a look at something like [SimpleMediator](https://github.com/dasiths/SimpleMediator) or [Brighter](https://github.com/BrighterCommand/Brighter) and NEventLite will complement them nicely.
2121

2222
## What about v1.0? Wasn't it advertised as a framework?
2323
*NEventLite V1.0 tried to solve similar problems but the scope of the project very large and it was decided to narrow down the scope. If you're still looking for reference it's hosted [here](https://github.com/dasiths/NEventLite/blob/master/legacy/v1.0).*
2424

25-
## Before you start
25+
## :eyes: Before you start
2626

2727
- The library targets .NET Standard 2.0
2828
- *Optional:* Installation of EventStore - [https://eventstore.com/](https://eventstore.com/) (You can use the in memory event and snapshot providers when developing)
2929

30-
## Using It
30+
## :hammer: Using It
3131

3232
Define the events. They are simple pocos that will be serialized and stored in `EventStorage` when changes are saved. Events use `Guid` for Id by *default* but they can be changed to use any data type as Id. See `Event<TAggregateKey, TEventKey>` for reference.
3333

@@ -144,7 +144,7 @@ Using the built in `Session` and `Repository` implementations to manage the Aggr
144144
}
145145
```
146146

147-
## Dependency Injection
147+
## :syringe: Dependency Injection
148148

149149
The library is built with DI as a first class concept. Wiring it up is easy. This is an example of how you would do it with `Microsoft.Extensions.DependencyInjection`. You can find a detailed [example in the sample console app](https://github.com/dasiths/NEventLite/blob/master/src/Samples/NEventLite.Samples.ConsoleApp/DependencyInjection.cs).
150150

@@ -166,9 +166,11 @@ The library is built with DI as a first class concept. Wiring it up is easy. Thi
166166
services.AddScoped<ISession<Schedule>, Session<Schedule>>();
167167

168168
// Or
169-
// Instead of specifying each Aggregate and Snapshot type you can use the convenience extension method "ScanAndRegisterAggregates()" in the "NEventLite.Extensions.Microsoft.DependencyInjection" nuget library as shown below
169+
// Instead of specifying each Aggregate and Snapshot type you can use the convenience
170+
// extension method "ScanAndRegisterAggregates()" in the
171+
// "NEventLite.Extensions.Microsoft.DependencyInjection" nuget library as shown below
170172
171-
//services.ScanAndRegisterAggregates();
173+
// services.ScanAndRegisterAggregates();
172174
173175
// Use the defaults
174176
services.AddSingleton<IClock, DefaultSystemClock>();
@@ -184,7 +186,7 @@ The library is built with DI as a first class concept. Wiring it up is easy. Thi
184186
}
185187
```
186188

187-
If you want to use it with a different dependency injection framework, you can look at how the assembly scanning and registration is implemented for `Microsoft.Extensions.DependencyInjection` as an example and come up with your own implementation.
189+
If you want to use it with a different dependency injection framework, you can look at how the assembly scanning and registration is implemented for `Microsoft.Extensions.DependencyInjection` as an example and come up with your own implementation. The file is [located here](https://github.com/dasiths/NEventLite/blob/master/src/Extensions/NEventLite.Extensions.Microsoft.DependencyInjection/Extensions.cs)
188190

189191
```csharp
190192
public static void ScanAndRegisterAggregates(this ServiceCollection services, IList<Assembly> assemblies)
@@ -221,7 +223,7 @@ If you want to use it with a different dependency injection framework, you can l
221223
}
222224
```
223225

224-
## Storage providers
226+
## :ledger: Storage providers
225227

226228
The library contains storage provider implementation for [EventSore](https://eventstore.com/) and we plan to include a few more in the future. We have also included an in memory event and snapshot storage provider to get you up and running faster.
227229

@@ -258,3 +260,5 @@ There are more examples in the [Samples folder](https://github.com/dasiths/NEven
258260
## Notes
259261

260262
Please feel free to contribute and improve the code as you see fit. Please raise an issue if you find a bug or have an improvement idea. The repository is shared under the MIT license.
263+
264+
**Share the :heart: and let your friends and colleagues know about this cool project. Thank you.**

appveyor.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
version: 2.0.{build}
1+
version: 2.1.{build}
22
pull_requests:
33
do_not_increment_build_number: true
44
branches:

0 commit comments

Comments
 (0)