Skip to content
This repository has been archived by the owner on May 20, 2020. It is now read-only.

Commit

Permalink
chore: update README and LICENSE
Browse files Browse the repository at this point in the history
  • Loading branch information
johnleider committed Oct 17, 2019
1 parent f2d4e8f commit 36736e5
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 9 deletions.
9 changes: 9 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -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.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
# Vuetify Vue CLI 3 Preset
# vue-cli-preset-vuetify
> A Vue CLI 3 Preset for generating scaffolded Vuetify applications
Extremely opinionated pre-configured Vuetify application. Includes the following features:

### πŸŽ‰ Installation
### πŸ’Ώ Install

```bash
vue create my-project --preset vuetifyjs/vue-cli-preset-vuetify
```

### 🏨 Default Component Structure
### πŸš€ Usage

#### Default Component Structure
Adds **base** and **core** components.

- **base**: Global components that are automatically loaded
- **core**: Application level components

### πŸš€ Vuetify
- Configured default IE11/Safari/Edge support.
#### Vuetify
- Configured default IE11/Safari/Edge support.
- Setup to use [vue-i18n](https://github.com/kazupon/vue-i18n)
- Setup to use [SASS Variables](https://vuetifyjs.com/en/customization/sass-variables)
- Setup to use [SASS Variables](https://vuetifyjs.com/customization/sass-variables)
- Setup to use [Material Design Icons SVG](https://github.com/Templarian/MaterialDesign-JS)

### πŸ”Œ Plugins
#### Plugins
- [vue-eslint](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-eslint)
- [eslint-config-vuetify](https://github.com/vuetifyjs/eslint-config-vuetify)
- [vue-jest](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-unit-jest)
Expand All @@ -30,6 +31,8 @@ Adds **base** and **core** components.
- [vuex](https://github.com/vuejs/vuex)
- Preconfigured modules
- [vuex-pathify](https://github.com/davestewart/vuex-pathify)
- [vue-cli-plugin-vuetify-cli](https://github.com/vuetifyjs/vue-cli-plugin-vuetify-cli)
- [vue-cli-plugin-vuetify-storybook](https://github.com/vuetifyjs/vue-cli-plugin-vuetify-storybook)
- [vuex-router-sync](https://github.com/vuejs/vuex-router-sync)
- [vue-meta](https://github.com/nuxt/vue-meta)
- [vue-analytics](https://github.com/MatteoGabriele/vue-analytics)
Expand Down

0 comments on commit 36736e5

Please sign in to comment.