From 5e8e7290a143097089b580408c81682fe7d338dc Mon Sep 17 00:00:00 2001 From: David Badura Date: Tue, 16 Apr 2024 17:51:07 +0200 Subject: [PATCH] update readme --- README.md | 18 +++++++++++------- docs/pages/index.md | 4 ++-- 2 files changed, 13 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 24e485455..eafb8eb92 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 @@ -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 | diff --git a/docs/pages/index.md b/docs/pages/index.md index b5789df1b..27edfe70d 100644 --- a/docs/pages/index.md +++ b/docs/pages/index.md @@ -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...