From f5f9eb8960569005fab1ff87b691abc7a1221077 Mon Sep 17 00:00:00 2001 From: RonnieSan Date: Mon, 21 May 2018 00:20:49 -0700 Subject: [PATCH] Updated documentation --- README.md | 6 +++++- template/src/{my-component.vue => example.vue} | 2 +- 2 files changed, 6 insertions(+), 2 deletions(-) rename template/src/{my-component.vue => example.vue} (89%) diff --git a/README.md b/README.md index 939a5c1..62f6f69 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,11 @@ You can then include the component on your page using the `name` property you se ``` -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`. +## 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 ``. + +## 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. ## IMPORTANT!!! diff --git a/template/src/my-component.vue b/template/src/example.vue similarity index 89% rename from template/src/my-component.vue rename to template/src/example.vue index 86471aa..b3dc5b5 100644 --- a/template/src/my-component.vue +++ b/template/src/example.vue @@ -6,7 +6,7 @@