Merge pull request #27 from prooph/restructure_docs

Restructure docs
prooph · Oct 14, 2017 · b5ad22f · b5ad22f
2 parents 2897d2f + f58b462
commit b5ad22f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 2 deletions.
diff --git 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
@@ -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