docs: preview the vue component as a document

vuese · Nov 8, 2018 · e26438b · e26438b
1 parent 489bb55
commit e26438b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -490,6 +490,20 @@ Then we get:
 |---|---|---|
 |clear|Used to manually clear the form|The argument is a boolean value representing xxx|
 
+### Preview the vue component as a document
+
+`vuese` also allows you to preview a vue component directly as a document, use the `preview` command:
+
+```sh
+vuese preview path-to-your-component.vue
+```
+
+`vuese` uses [carlo](https://github.com/GoogleChromeLabs/carlo), the preview will be updated in real time when you modify the component.
+
+As an example:
+
+![preview](https://github.com/HcySunYang/vuese/blob/master/imgs/preview.gif)
+
 ## Contributing
 
 1. Fork it!

diff --git a/imgs/preview.gif b/imgs/preview.gif