From 92385aa2bae4a4f16f3fb7d0d31efb2ef8fbd8fc Mon Sep 17 00:00:00 2001 From: John Leider Date: Thu, 17 Oct 2019 15:40:05 -0500 Subject: [PATCH] chore: update README and LICENSE --- LICENSE.md | 9 +++++++++ README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 54 insertions(+), 2 deletions(-) create mode 100644 LICENSE.md diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..bad9be6 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,9 @@ +# Released under MIT License + +Copyright (c) 2016-present Vuetify LLC + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 6963038..f52ffe9 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,45 @@ -# Vuetify CLI -Coming soon... +# vue-cli-plugin-vuetify-cli +> A Vue CLI 3 Plugin for scaffolding Vuetify application components, directives, mixins and views. + +### 💿 Install + +```bash +vue install vuetify-cli +``` + +### 🚀 Usage +After installation, you should have 4 new scripts in your `package.json` file. These will take you through various prompts that will scaffold pre-made templates. + +--Still under construction-- + +### 🚙 Roadmap +- [ ] Allow customization of generated templates +- [ ] Allow customization of directory structures used + +### 💪 Supporting Vuetify +

Vuetify is an open source MIT project that has been made possible due to the generous contributions by community backers. If you are interested in supporting this project, please consider:

+ + + +### 📑 License +[MIT](http://opensource.org/licenses/MIT) + +Copyright (c) 2016-present Vuetify LLC