Skip to content

Commit 72a41a4

Browse files
committed
docs: update README
1 parent b40903e commit 72a41a4

File tree

1 file changed

+38
-53
lines changed

1 file changed

+38
-53
lines changed

README.md

+38-53
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,30 @@
1+
# CoreUI Free Vue Admin Template [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&logo=twitter)](https://twitter.com/intent/tweet?text=CoreUI%20-%20Free%Vue%204%20Admin%20Template%20&url=https://coreui.io&hashtags=bootstrap,admin,template,dashboard,panel,free,angular,react,vue)
2+
3+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)
14
[![@coreui coreui](https://img.shields.io/badge/@coreui%20-coreui-lightgrey.svg?style=flat-square)](https://github.com/coreui/coreui)
25
[![npm package][npm-coreui-badge]][npm-coreui]
3-
[![NPM downloads][npm-coreui-download]][npm-coreui]
6+
[![NPM downloads][npm-coreui-download]][npm-coreui]
47
[![@coreui vue](https://img.shields.io/badge/@coreui%20-vue-lightgrey.svg?style=flat-square)](https://github.com/coreui/vue)
58
[![npm package][npm-coreui-vue-badge]][npm-coreui-vue]
69
[![NPM downloads][npm-coreui-vue-download]][npm-coreui-vue]
7-
[![npm next][npm-next]][npm]
810

911
[npm-coreui]: https://www.npmjs.com/package/@coreui/coreui
1012
[npm-coreui-badge]: https://img.shields.io/npm/v/@coreui/coreui.png?style=flat-square
1113
[npm-coreui-download]: https://img.shields.io/npm/dm/@coreui/coreui.svg?style=flat-square
1214
[npm-coreui-vue]: https://www.npmjs.com/package/@coreui/vue
1315
[npm-coreui-vue-badge]: https://img.shields.io/npm/v/@coreui/vue.png?style=flat-square
1416
[npm-coreui-vue-download]: https://img.shields.io/npm/dm/@coreui/vue.svg?style=flat-square
15-
[npm-next]: https://img.shields.io/npm/v/@coreui/vue/next.png?style=flat-square
1617
[npm]: https://www.npmjs.com/package/@coreui/vue
1718

18-
# CoreUI Free Vue Admin Template
19+
[![Bootstrap Admin Template](https://assets.coreui.io/products/coreui-free-bootstrap-admin-template-light-dark.webp)](https://coreui.io/product/free-react-admin-template/)
1920

2021
CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of redundant components, so the app is light enough to offer ultimate user experience. This means mobile devices also, where the navigation is just as easy and intuitive as on a desktop or laptop. The CoreUI Layout API lets you customize your project for almost any device – be it Mobile, Web or WebApp – CoreUI covers them all!
2122

2223
## Table of Contents
2324

2425
* [Versions](#versions)
25-
* [CoreUI Pro](#coreui-pro)
26+
* [CoreUI PRO](#coreui-pro)
27+
* [CoreUI PRO Vue Admin Templates](#coreui-pro-vue-admin-templates)
2628
* [Quick Start](#quick-start)
2729
* [Installation](#installation)
2830
* [Basic usage](#basic-usage)
@@ -31,6 +33,7 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
3133
* [Versioning](#versioning)
3234
* [Creators](#creators)
3335
* [Community](#community)
36+
* [Support CoreUI Development](#support-coreui-development)
3437
* [Copyright and License](#copyright-and-license)
3538

3639
## Versions
@@ -40,12 +43,22 @@ CoreUI is meant to be the UX game changer. Pure & transparent code is devoid of
4043
* [CoreUI Free React.js Admin Template](https://github.com/coreui/coreui-free-react-admin-template)
4144
* [CoreUI Free Vue.js Admin Template](https://github.com/coreui/coreui-free-vue-admin-template)
4245

43-
## CoreUI Pro
46+
## CoreUI PRO
47+
48+
* 💪 [CoreUI PRO Angular Admin Template](https://coreui.io/product/angular-dashboard-template/)
49+
* 💪 [CoreUI PRO Bootstrap Admin Template](https://coreui.io/product/bootstrap-dashboard-template/)
50+
* 💪 [CoreUI PRO React Admin Template](https://coreui.io/product/react-dashboard-template/)
51+
* 💪 [CoreUI PRO Vue Admin Template](https://coreui.io/product/vue-dashboard-template/)
52+
53+
## CoreUI PRO Vue Admin Templates
54+
55+
| Default Theme | Light Theme |
56+
| --- | --- |
57+
| [![CoreUI PRO Vue Admin Template](https://coreui.io/images/templates/coreui_pro_default_light_dark.webp)](https://coreui.io/product/vue-dashboard-template/?theme=default) | [![CoreUI PRO Vue Admin Template](https://coreui.io/images/templates/coreui_pro_light_light_dark.webp)](https://coreui.io/product/vue-dashboard-template/?theme=light)|
4458

45-
* 💪 [CoreUI Pro Angular Admin Template](https://coreui.io/product/angular-dashboard-template/)
46-
* 💪 [CoreUI Pro Bootstrap Admin Template](https://coreui.io/product/bootstrap-dashboard-template/)
47-
* 💪 [CoreUI Pro React Admin Template](https://coreui.io/product/react-dashboard-template/)
48-
* 💪 [CoreUI Pro Vue Admin Template](https://coreui.io/product/vue-dashboard-template/)
59+
| Default Theme v3 | Light Theme v3 |
60+
| --- | --- |
61+
| [![CoreUI PRO Vue Admin Template](https://coreui.io/images/templates/coreui_pro_default_v3_light_dark.webp)](https://coreui.io/product/vue-dashboard-template/?theme=default-v3) | [![CoreUI PRO Vue Admin Template](https://coreui.io/images/templates/coreui_pro_light_v3_light_dark.webp)](https://coreui.io/product/vue-dashboard-template/?theme=light)|
4962

5063
## Quick Start
5164

@@ -103,22 +116,21 @@ Within the download you'll find the following directories and files, logically g
103116
```
104117
coreui-free-vue-admin-template
105118
├── public/ # static files
106-
│ └── index.html # html template
107-
108119
├── src/ # project root
109120
│ ├── assets/ # images, icons, etc.
110121
│ ├── components/ # common components - header, footer, sidebar, etc.
111122
│ ├── layouts/ # layout containers
112123
│ ├── scss/ # scss styles
113124
│ ├── router # routes config
114-
── store # template state example
125+
── store # template state example
115126
│ ├── views/ # application views
116127
│ ├── _nav.js # sidebar navigation config
117128
│ ├── App.vue
118129
│ ├── ...
119130
│ └── main.js
120-
121-
└── package.json
131+
├── index.html # html template
132+
├── package.json
133+
└── vite.config.js
122134
```
123135

124136
## Documentation
@@ -134,12 +146,19 @@ See [the Releases section of our project](https://github.com/coreui/coreui-free-
134146
## Creators
135147

136148
**Łukasz Holeczek**
149+
137150
* <https://twitter.com/lukaszholeczek>
138151
* <https://github.com/mrholek>
139-
* <https://github.com/coreui>
140152

141-
**CoreUI team**
142-
* https://github.com/orgs/coreui/people
153+
**Andrzej Kopański**
154+
155+
* <https://github.com/xidedix>
156+
157+
**CoreUI Team**
158+
159+
* <https://twitter.com/core_ui>
160+
* <https://github.com/coreui>
161+
* <https://github.com/orgs/coreui/people>
143162

144163
## Community
145164

@@ -150,41 +169,7 @@ Get updates on CoreUI's development and chat with the project maintainers and co
150169

151170
## Support CoreUI Development
152171

153-
CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the [CoreUI PRO](https://coreui.io/pricing/) or by becoming a sponsor via [Open Collective](https://opencollective.com/coreui/).
154-
155-
<!--- StartOpenCollectiveBackers -->
156-
157-
### Platinum Sponsors
158-
159-
Support this project by [becoming a Platinum Sponsor](https://opencollective.com/coreui/contribute/platinum-sponsor-40959/). A large company logo will be added here with a link to your website.
160-
161-
<a href="https://opencollective.com/coreui/contribute/platinum-sponsor-40959/checkout"><img src="https://opencollective.com/coreui/tiers/platinum-sponsor/0/avatar.svg?avatarHeight=100"></a>
162-
163-
### Gold Sponsors
164-
165-
Support this project by [becoming a Gold Sponsor](https://opencollective.com/coreui/contribute/gold-sponsor-40960/). A big company logo will be added here with a link to your website.
166-
167-
<a href="https://opencollective.com/coreui/contribute/gold-sponsor-40960/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
168-
169-
### Silver Sponsors
170-
171-
Support this project by [becoming a Silver Sponsor](https://opencollective.com/coreui/contribute/silver-sponsor-40967/). A medium company logo will be added here with a link to your website.
172-
173-
<a href="https://opencollective.com/coreui/contribute/silver-sponsor-40967/checkout"><img src="https://opencollective.com/coreui/tiers/gold-sponsor/0/avatar.svg?avatarHeight=100"></a>
174-
175-
### Bronze Sponsors
176-
177-
Support this project by [becoming a Bronze Sponsor](https://opencollective.com/coreui/contribute/bronze-sponsor-40966/). The company avatar will show up here with a link to your OpenCollective Profile.
178-
179-
<a href="https://opencollective.com/coreui/contribute/bronze-sponsor-40966/checkout"><img src="https://opencollective.com/coreui/tiers/bronze-sponsor/0/avatar.svg?avatarHeight=100"></a>
180-
181-
### Backers
182-
183-
Thanks to all the backers and sponsors! Support this project by [becoming a backer](https://opencollective.com/coreui/contribute/backer-40965/).
184-
185-
<a href="https://opencollective.com/coreui/contribute/backer-40965/checkout" target="_blank" rel="noopener"><img src="https://opencollective.com/coreui/backers.svg?width=890"></a>
186-
187-
<!--- EndOpenCollectiveBackers -->
172+
CoreUI is an MIT-licensed open source project and is completely free to use. However, the amount of effort needed to maintain and develop new features for the project is not sustainable without proper financial backing. You can support development by buying the [CoreUI PRO](https://coreui.io/pricing/?framework=vue&src=github-coreui-free-vue-admin-template) or by becoming a sponsor via [Open Collective](https://opencollective.com/coreui/).
188173

189174
## Copyright and License
190175

0 commit comments

Comments
 (0)