docs(docz-example-basic): add instructions to quickly run the example

doczjs · Aug 27, 2019 · a4f9203 · a4f9203
1 parent 84918d8
commit a4f9203
Showing 1 changed file with 21 additions and 0 deletions.
diff --git a/examples/basic/README.md b/examples/basic/README.md
@@ -0,0 +1,21 @@
+# Basic Docz example
+
+## Download manually
+
+```sh
+curl https://codeload.github.com/pedronauck/docz/tar.gz/master | tar -xz --strip=2 docz-master/examples/basic
+mv basic docz-basic-example
+cd docz-basic-example
+```
+
+## Setup
+
+```sh
+yarn # npm i
+```
+
+## Run
+
+```sh
+yarn dev # npm run dev
+```