diff --git a/README.md b/README.md index 92f5c43..966d6ef 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # vue-standalone-component Vuejs standalone component template using karma for testing + +> Build your standalone components using this tiny template. + +> This template is Vue 2.x **only**. + +### Usage + +This is a project template for [vue-cli](https://github.com/vuejs/vue-cli). + +``` bash +$ npm install -g vue-cli +$ vue init InCuca/vue-standalone-component my-component +$ cd my-component +$ npm run dev +``` + +The generated output in ./dist can be used with node and the browser. + +### What's Included + +- Gulp tasks for development building, testing and development server +- Karma for testing + +### Testing + +``` bash +$ npm test +``` + +### Building to ./build + +``` bash +$ npm run build +`` diff --git a/meta.json b/meta.json new file mode 100644 index 0000000..986c87e --- /dev/null +++ b/meta.json @@ -0,0 +1,21 @@ +{ + "prompts": { + "name": { + "type": "string", + "required": true, + "label": "Component name in kebab-case format", + "default": "v-awesome-component" + }, + "description": { + "type": "string", + "required": true, + "label": "Project description", + "default": "A Vue.js component" + }, + "author": { + "type": "string", + "label": "Author" + } + }, + "completeMessage": "To get started:\n\n{{^inPlace}}cd {{destDirName}}\n\n{{/inPlace}}1. Write your component in src/Component.vue\n2. Write a demo in src/demo.vue\n3. npm run dev\n4. npm run dist\n5. npm run dist:demo\n6. npm run demo:open" +}