Skip to content
This repository was archived by the owner on May 8, 2025. It is now read-only.

Commit ceb1247

Browse files
committed
chore: update README and LICENSE file
1 parent 7c804a0 commit ceb1247

File tree

2 files changed

+43
-16
lines changed

2 files changed

+43
-16
lines changed

LICENSE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
The MIT License (MIT)
1+
# Released under MIT License
22

3-
Copyright (c) 2016-2019 John Jeremy Leider
3+
Copyright (c) 2016-present Vuetify LLC
44

55
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:
66

README.md

Lines changed: 41 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,47 @@
11
# vue-cli-plugin-vuetify
22

3-
Vuetify Plugin for [vue-cli@3.0](https://github.com/vuejs/vue-cli)
3+
> A [Vue CLI 3 Plugin](https://github.com/vuejs/vue-cli) for installing Vuetify
44
5-
## Install
5+
### 💿 Install
66

77
If you haven't yet installed vue-cli 3, first follow the install instructions here: https://github.com/vuejs/vue-cli
88

99
**Tip**: If you don't want to overwrite your current vue-cli because you still need `vue init`, [then try this](https://cli.vuejs.org/guide/creating-a-project.html#pulling-2-x-templates-legacy).
1010

11-
Generate a project using vue-cli 3.0
12-
```
11+
Generate a project using vue-cli 3.0:
12+
```bash
1313
vue create my-app
1414
```
1515

16-
Before installing the vuetify plugin, make sure to commit or stash your changes in case you need to revert
16+
Before installing the vuetify plugin, make sure to commit or stash your changes in case you need to revert the changes.
1717

18-
To install the vuetify plugin...
19-
```
18+
To install the vuetify plugin simply navigate to your application folder and add Vuetify.
19+
```bash
2020
cd my-app
21+
2122
vue add vuetify
2223
```
2324

24-
If you run into any issues you can hit us up on [discord/need](https://discordapp.com/channels/340160225338195969/340215499398840331).
25+
If you run into any issues, reach out to us in our [Discord Community server](https://community.vuetifyjs.com).
2526

26-
## Using with other plugins
27+
### 🚀 Usage
2728

2829
Here are some extra steps for setting up the old templates but using plugins from the new ecosystem.
2930

30-
### Nuxt
31+
#### Nuxt
3132

3233
```
3334
# preset: default (babel, eslint)
3435
3536
vue add nuxt-starter-template
36-
3737
```
3838

3939
Todo
4040

4141
- Add vuetify Nuxt starter template
4242

4343

44-
### Electron
44+
#### Electron
4545

4646
Just add [vue-cli-plugin-electron-builder](https://nklayman.github.io/vue-cli-plugin-electron-builder/)
4747

@@ -51,12 +51,12 @@ vue add vuetify
5151
yarn electron:serve
5252
```
5353

54-
### PWA
54+
#### PWA
5555

5656
If you already made a project with the PWA option selected, then just adding like above should do it.
5757

5858

59-
### Cordova
59+
#### Cordova
6060

6161
Use the [Cordova](https://github.com/m0dch3n/vue-cli-plugin-cordova) plugin.
6262

@@ -72,3 +72,30 @@ npm run cordova-serve-browser # Development Browser
7272
npm run cordova-build-browser # Build Browser
7373
```
7474

75+
### 💪 Supporting Vuetify
76+
<p>Vuetify is an open source MIT project that has been made possible due to the generous contributions by <a href="https://github.com/vuetifyjs/vuetify/blob/dev/BACKERS.md">community backers</a>. If you are interested in supporting this project, please consider:</p>
77+
78+
<ul>
79+
<li>
80+
<a href="https://github.com/users/johnleider/sponsorship">Becoming a sponsor on Github</a>
81+
<strong><small>(supports John)</small></strong>
82+
</li>
83+
<li>
84+
<a href="https://opencollective.com/vuetify">Becoming a backer on OpenCollective</a>
85+
<strong><small>(supports the Dev team)</small></strong>
86+
</li>
87+
<li>
88+
<a href="https://tidelift.com/subscription/npm/vuetify?utm_source=vuetify&utm_medium=referral&utm_campaign=readme">Become a subscriber on Tidelift</a>
89+
</li>
90+
<li>
91+
<a href="https://paypal.me/vuetify">Make a one-time payment with Paypal</a>
92+
</li>
93+
<li>
94+
<a href="https://vuetifyjs.com/getting-started/consulting-and-support?ref=github">Book time with John</a>
95+
</li>
96+
</ul>
97+
98+
### 📑 License
99+
[MIT](http://opensource.org/licenses/MIT)
100+
101+
Copyright (c) 2016-present Vuetify LLC

0 commit comments

Comments
 (0)