Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidBadura committed Apr 16, 2024
1 parent 947577a commit 5e8e729
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ A lightweight but also all-inclusive event sourcing library with a focus on deve
* Everything is included in the package for event sourcing
* Based on [doctrine dbal](https://github.com/doctrine/dbal) and their ecosystem
* Developer experience oriented and fully typed
* Automatic [snapshot](https://patchlevel.github.io/event-sourcing-docs/latest/snapshots/)-system to boost your performance
* [Split](https://patchlevel.github.io/event-sourcing-docs/latest/split_stream/) big aggregates into multiple streams
* Build-in [pipeline](https://patchlevel.github.io/event-sourcing-docs/latest/pipeline/) to export, import and migrate event streams
* Versioned and managed lifecycle of [projections](https://patchlevel.github.io/event-sourcing-docs/latest/projection/)
* Smooth [upcasting](https://patchlevel.github.io/event-sourcing-docs/latest/upcasting/) of old events
* Simple setup with [scheme management](https://patchlevel.github.io/event-sourcing-docs/latest/store/) and [doctrine migration](https://patchlevel.github.io/event-sourcing-docs/latest/migration/)
* Built in [cli commands](https://patchlevel.github.io/event-sourcing-docs/latest/cli/) with [symfony](https://symfony.com/)
* Automatic [snapshot](https://patchlevel.github.io/event-sourcing-docs/latest/snapshots)-system to boost your performance
* [Split](https://patchlevel.github.io/event-sourcing-docs/latest/split_stream) big aggregates into multiple streams
* Versioned and managed lifecycle of [subscriptions](https://patchlevel.github.io/event-sourcing-docs/latest/subscription) like projections and processors
* Safe usage of [Personal Data](https://patchlevel.github.io/event-sourcing-docs/latest/personal_data) with crypto-shredding
* Smooth [upcasting](https://patchlevel.github.io/event-sourcing-docs/latest/upcasting) of old events
* Simple setup with [scheme management](https://patchlevel.github.io/event-sourcing-docs/latest/store) and [doctrine migration](https://patchlevel.github.io/event-sourcing-docs/latest/store)
* Built in [cli commands](https://patchlevel.github.io/event-sourcing-docs/latest/cli) with [symfony](https://symfony.com/)
* and much more...

## Installation
Expand All @@ -30,6 +30,7 @@ composer require patchlevel/event-sourcing
## Documentation

* Latest [Docs](https://patchlevel.github.io/event-sourcing-docs/latest)
* 3.0 [Docs](https://patchlevel.github.io/event-sourcing-docs/3.0) (preview)

## Integration

Expand All @@ -42,6 +43,9 @@ We officially only support the databases and versions listed in the table, as th
Since the package is based on doctrine dbal, other databases such as OracleDB and MSSQL may also work.
But we can only really support the databases if we can also automatically ensure that they don't break due to changes.

> [!TIP]
> We recommend using PostgresSQL.
| Database | Version |
|-------------|---------------------------------|
| PostgresSQL | 12.17, 13.13, 14.10, 15.5, 16.1 |
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ A lightweight but also all-inclusive event sourcing library with a focus on deve
* Developer experience oriented and fully typed
* Automatic [snapshot](snapshots.md)-system to boost your performance
* [Split](split_stream.md) big aggregates into multiple streams
* Build-in [pipeline](pipeline.md) to export, import and migrate event streams
* Versioned and managed lifecycle of [subscriptions](subscription.md) like projections and processors
* Safe usage of [Personal Data](personal_data.md) with crypto-shredding
* Smooth [upcasting](upcasting.md) of old events
* Simple setup with [scheme management](store.md) and [doctrine migration](migration.md)
* Simple setup with [scheme management](store.md) and [doctrine migration](store.md)
* Built in [cli commands](cli.md) with [symfony](https://symfony.com/)
* and much more...

Expand Down

0 comments on commit 5e8e729

Please sign in to comment.