Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mizrael authored Jun 28, 2024
1 parent 28faf9c commit adfabfd
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

[![Tests](/~https://github.com/mizrael/EvenireDB/actions/workflows/dotnet.yml/badge.svg)](/~https://github.com/mizrael/EvenireDB/actions/workflows/dotnet.yml)
![coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/mizrael/ebd585c5ad0069d0e8486e43cade5793/raw/eveniredb-code-coverage.json)
[![Nuget](https://img.shields.io/nuget/v/Blazorex?style=plastic)](https://www.nuget.org/packages/EvenireDB.Client/)

> [Evenire](https://en.wiktionary.org/wiki/evenire), from Latin, present active infinitive of *ēveniō*, "to happen".
Expand All @@ -18,7 +19,7 @@ Honestly, I don't know how far this project will go, but I'm having a lot of fun

The basic idea behind Evenire is quite simple: events can be appended to streams and later on, retrieved by providing the stream ID.

Streams are identified by a tuple composed of a `Guid` (the stream key) and a string (the stream type). For the curious, the sources are [here](./src/EvenireDB.Common/StreamId.cs)).
Streams are identified by a tuple composed of a `Guid` (the stream key) and a string (the stream type). For the curious, the sources are [here](/~https://github.com/mizrael/EvenireDB/tree/main/src/EvenireDB.Common/StreamId.cs)).

Every stream is kept in memory using a local cache, for fast retrieval. A background process takes care of serializing events to a file, one per stream.

Expand Down Expand Up @@ -106,9 +107,9 @@ Evenire also has a rudimentary administration UI, written with Blazor. It allows
- append events to an existing stream
- delete a stream

![streams archive](./docs/assets/streams_archive.jpg)
![streams archive](https://raw.githubusercontent.com/mizrael/EvenireDB/main/docs/assets/streams_archive.jpg)

![stream details](./docs/assets/stream_details.jpg)
![stream details](https://raw.githubusercontent.com/mizrael/EvenireDB/main/docs/assets/stream_details.jpg)

## Samples
- [TemperatureSensors](/~https://github.com/mizrael/EvenireDB/tree/main/samples/EvenireDB.Samples.TemperatureSensors) shows how to use a Background worker to produce events and uses Minimal APIs to retrieve the latest events for a specific stream.
Expand Down

0 comments on commit adfabfd

Please sign in to comment.