me
/
vue-sfc-compiler
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added explanation of example component in the README

This commit is contained in:
RonnieSan 2018-05-21 00:27:51 -07:00
parent f5f9eb8960
commit 437f53b1d0
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -79,6 +79,8 @@ You can then include the component on your page using the `name` property you se
## Included Example
The template package includes a sample component (`my-component.vue`) that you can test it all out with. The command you would use to compile it would be `webpack --env.file=example`. The component has a name property of `example`, the the tagname you would use in your HTML woudl be `<example></example>`.
The example component will print out the words "Hello, world." When the text is clicked, the word "world" will change to "foobar".
## Converting an existing Vue Single File Component to a standalone JS file
To convert an existing Vue Single File Component to a standalone JS file, simple add it to the `src` folder along with all the required dependencies (make sure all the paths are correct for the dependencies). Then run the compiler (`webpack` command) with the `--env.file` argument pointing to the component. If anything goes wrong, the compiler will tell you what errors occured.