We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 3a43db4 commit 4c507fbCopy full SHA for 4c507fb
README.md
@@ -1,2 +1,21 @@
1
-# snapshooter-docs
2
-The snapshooter documentation
+# snapshooter Documentation
+
3
+[Documentation](https://swisslife-oss.github.io/snapshooter/) for [snapshooter](https://github.com/SwissLife-OSS/snapshooter) project.
4
5
+## Running this documentation on your local machine
6
7
+run the following command in the root of this repository
8
9
+```bash
10
+docker-compose up
11
+```
12
13
+if you don't have docker installed you can try the following
14
15
16
+cd website
17
+yarn
18
+yarn start
19
20
21
+You can now acces the documentation in your browser under [localhost:3000/snapshooter](http://localhost:3000/snapshooter)
0 commit comments