From f58b462b6b6e992d4800082e1b0a6ddfdebb7972 Mon Sep 17 00:00:00 2001 From: codeliner Date: Sun, 15 Oct 2017 01:19:20 +0200 Subject: [PATCH] Restructure docs --- docs/bookdown.json | 5 +++-- docs/snapshots.md | 10 ++++++++++ 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/docs/bookdown.json b/docs/bookdown.json index 0333896..0265b2f 100644 --- a/docs/bookdown.json +++ b/docs/bookdown.json @@ -1,9 +1,10 @@ { - "title": "Prooph EventSourcing", + "title": "Snapshotter", "content": [ - {"intro": "../README.md"}, {"snapshots": "snapshots.md"} ], + "tocDepth": 1, + "numbering": false, "target": "./html", "template": "../vendor/prooph/bookdown-template/templates/main.php" } diff --git a/docs/snapshots.md b/docs/snapshots.md index c335088..b6b984c 100644 --- a/docs/snapshots.md +++ b/docs/snapshots.md @@ -1,5 +1,15 @@ # Snapshotter +Snapshot tool for the prooph event-store. Take aggregate snapshots with ease. + +## Installation + +``` +composer require prooph/snapshotter +``` + +## Snapshots via Projection + There are two projections shipped with this package: 1) CategorySnapshotProjection