From 437f53b1d00e206b8cf1307bb970a4c68f93bb34 Mon Sep 17 00:00:00 2001 From: RonnieSan Date: Mon, 21 May 2018 00:27:51 -0700 Subject: [PATCH] Added explanation of example component in the README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 62f6f69..a78592e 100644 --- a/README.md +++ b/README.md @@ -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 ``. +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.