diff --git a/.gitignore b/.gitignore index 92290bf..fe3f0e7 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,4 @@ infection.log *.drawio.bkp *.drawio.dtmp - +.env diff --git a/README.md b/README.md index 095e92d..49daa35 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ composer require phauthentic/event-sourcing ## Documentation -* [What is Event Sourcing?](docs/Event-Sourcing.md) +* [What is Event Sourcing?](docs/What-is-Event-Sourcing) * [The Architecture of this Library](docs/Architecture.md) * [Make your Aggregates Using Event Sourcing](docs/Make-your-Aggregate-using-Event-Sourcing.md) * [Example](docs/Example.md) diff --git a/docs/Architecture.md b/docs/Architecture.md index 6356adc..32babb0 100644 --- a/docs/Architecture.md +++ b/docs/Architecture.md @@ -6,7 +6,7 @@ This document provides an overview and a rationale of the architecture of the li The driving quality attributes of this library are: -* **Simplicity**: The code should be as minimal as possible and as decoupled as possible from your domain. +* **Simplicity**: The code should be as minimal as possible and as decoupled as possible from any domain and framework. * **Flexibility**: The library should be flexible enough to be used in a variety of scenarios. * **Extensibility**: The library should be easy to extend. * **Learnability**: The library should be easy to learn and getting started. @@ -15,7 +15,8 @@ This means that the library tries to minimize 3rd party dependencies as much as Other libraries may provide more features, but this library aims to provide a solid but **simple** foundation for building event sourced applications. Usually you should start small and then grow. We believe that this library here is perfect to get quickly started but is offering enough extension points to deal with more evolving complex scenarios as well. -> Elon Musk: Delete any part or process you can. You may have to add them back later. In fact, if you do not end up adding back at least 10 percent of them, then you didn't delete enough. +> *Delete any part or process you can. You may have to add them back later. In fact, if you do not end up adding back at least 10 percent of them, then you didn't delete enough.* +> -- Elon Musk ![Simplicity vs Complexity](images/raptor-v1-vs-v2.jpg) diff --git a/docs/Example.md b/docs/Example.md index 860c929..105bc18 100644 --- a/docs/Example.md +++ b/docs/Example.md @@ -1,4 +1,6 @@ -# Example +# Event Sourcing Usage Example + +This example is showing the usage of event sourcing and this library with the example code provides as part of this repository in `/examples/`. ```php