Documentation

Phauthentic · Jun 30, 2024 · af18fcd · af18fcd
1 parent ae4a5e3
commit af18fcd
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -22,25 +22,11 @@ composer require phauthentic/event-sourcing
 
 ## Documentation
 
-Please start by reading [the docs folder](/docs/Index.md) in this repository.
-
-## Other Event Sourcing Libraries
-
-If you don't like this library, you might get happy with one of those. We think that different libraries for the same purpose approach the same problem from different angles and probably for different skill levels and audiences. Therefor we are happy to provide you with a list of alternatives.
-
-It would be nice if you could tell us why you preferred another library, thank you!
-
-### [Event Sauce](https://eventsauce.io/)     
-
-A wide used an well know library.
-
-### [Prooph Event Sourcing](https://github.com/prooph/event-sourcing) 
-
-A very well engineered library, but it seems to be unmaintained. Some might even call it over-engineered, however it is a very good library.
-
-### [Patchlevel Event Sourcing](https://github.com/patchlevel/event-sourcing)
-
-A library that is very tightly coupled with Symfony and Doctrine. It has a lot of dependencies and is not as flexible as the other libraries.
+* [What is Event Sourcing?](docs/Event-Sourcing.md)
+* [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)
+* [Other Event Sourcing Libraries](docs/Other-Event-Sourcing-Libraries.md)
 
 ## License
 

diff --git a/docs/Index.md b/docs/Index.md
diff --git a/...ake-you-Aggregate-using-Event-Sourcing.md → ...ke-your-Aggregate-using-Event-Sourcing.md b/...ake-you-Aggregate-using-Event-Sourcing.md → ...ke-your-Aggregate-using-Event-Sourcing.md
diff --git a/docs/Other-Event-Sourcing-Libraries.md b/docs/Other-Event-Sourcing-Libraries.md
@@ -0,0 +1,17 @@
+# Other Event Sourcing Libraries
+
+If you don't like this library, you might get happy with one of those. We think that different libraries for the same purpose approach the same problem from different angles and probably for different skill levels and audiences. Therefor we are happy to provide you with a list of alternatives.
+
+It would be nice if you could tell us why you preferred another library, thank you!
+
+## [Event Sauce](https://eventsauce.io/)     
+
+A wide used an well know library.
+
+## [Prooph Event Sourcing](https://github.com/prooph/event-sourcing) 
+
+A very well engineered library, but it seems to be unmaintained. Some might even call it over-engineered, however it is a very good library.
+
+## [Patchlevel Event Sourcing](https://github.com/patchlevel/event-sourcing)
+
+A library that is very tightly coupled with Symfony and Doctrine. It has a lot of dependencies and is not as flexible as the other libraries.