From 0a25377e6473e2cd42f18acd673542b777ddde88 Mon Sep 17 00:00:00 2001 From: David Badura Date: Wed, 29 Jun 2022 09:40:00 +0200 Subject: [PATCH] make clock clearer & fix readme --- README.md | 13 +++++++------ docs/pages/aggregate.md | 5 +++-- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 485fb433..d95962cd 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ 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 -* [Snapshots](docs/snapshots.md) system to quickly rebuild the aggregates -* [Pipeline](docs/pipeline.md) to build new [projections](docs/projection.md) or to migrate events -* [Scheme management](docs/store.md) and [doctrine migration](docs/store.md) support -* Dev [tools](docs/tools.md) such as a realtime event watcher -* Built in [cli commands](docs/cli.md) with [symfony](https://symfony.com/) +* [Snapshots](https://patchlevel.github.io/event-sourcing-docs/latest/snapshots/) system to quickly rebuild the aggregates +* [Pipeline](https://patchlevel.github.io/event-sourcing-docs/latest/pipeline/) to build new [projections](https://patchlevel.github.io/event-sourcing-docs/latest/projection/) or to migrate events +* [Scheme management](https://patchlevel.github.io/event-sourcing-docs/latest/store/) and [doctrine migration](https://patchlevel.github.io/event-sourcing-docs/latest/migration/) support +* Dev [tools](https://patchlevel.github.io/event-sourcing-docs/latest/watch_server/) such as a realtime event watcher +* Built in [cli commands](https://patchlevel.github.io/event-sourcing-docs/latest/cli/) with [symfony](https://symfony.com/) ## Installation @@ -26,7 +26,8 @@ composer require patchlevel/event-sourcing ## Documentation -* [Docs](https://patchlevel.github.io/event-sourcing-docs/latest) +* Latest [Docs](https://patchlevel.github.io/event-sourcing-docs/latest) +* 1.3 [Docs](https://github.com/patchlevel/event-sourcing/blob/1.3.x/README.md) ## Integration diff --git a/docs/pages/aggregate.md b/docs/pages/aggregate.md index 2274c516..a642270d 100644 --- a/docs/pages/aggregate.md +++ b/docs/pages/aggregate.md @@ -589,7 +589,7 @@ final class Profile extends AggregateRoot } ``` -But if you still want to make sure that the time is now and not in the past or future, you can pass a clock. +But if you still want to make sure that the time is "now" and not in the past or future, you can pass a clock. ```php use Patchlevel\EventSourcing\Aggregate\AggregateRoot; @@ -616,7 +616,8 @@ final class Profile extends AggregateRoot } ``` -This gives you the option of implementing the clock, e.g. use the FrozenClock to always get the same time. +Now you can pass the `SystemClock` to determine the current time. +Or for test purposes the `FrozenClock`, which always returns the same time. !!! note