Skip to content

Commit 88506db

Browse files
committed
docs: README update
1 parent bc1cf95 commit 88506db

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

README.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,32 @@
1-
# Introduction
1+
## CoreUI v3 for Vue.js
22

3+
> A [@coreui/vue](https://coreui.io/vue) `v3` components library project.
4+
5+
[![npm-coreui-vue-next][npm-coreui-vue-next]][npm]
36
[![Npm badge](https://img.shields.io/npm/v/@coreui/vue.svg)][npm]
47
[![NPM downloads][npm-download]][npm]
58
![Jest](https://img.shields.io/badge/Jest-^24.9.0-blue.svg)
6-
![Vue](https://img.shields.io/badge/Vue-^2.6.10-brightgreen.svg)
9+
![Vue](https://img.shields.io/badge/Vue-^2.6.10-brightgreen.svg)
710

811
[npm]: https://www.npmjs.com/package/@coreui/vue
912
[npm-download]: https://img.shields.io/npm/dm/@coreui/vue.svg?style=flat-square
13+
[npm-coreui-vue-next]: https://img.shields.io/npm/v/@coreui/vue/next.png?style=flat-square
1014

11-
> A [@coreui/vue](https://coreui.io/vue) `v3` components library project
15+
### Introduction
1216

13-
## Over 90 bootstrap based Vue.js components and directives!
14-
Check out template build on top of this library: [CoreUI](https://coreui.io/vue/) Open Source Bootstrap Admin Template
17+
#### Over 90 bootstrap based Vue.js components and directives!
1518

16-
## Installation
17-
```
18-
npm install @coreui/vue
19+
[Explore CoreUI v3 for Vue.js docs »](https://coreui.io/vue/docs)
20+
21+
Check out template build on top of this library: [CoreUI Open Source Bootstrap Admin Template »](https://coreui.io/vue/)
22+
23+
---
24+
25+
### Installation
26+
27+
```bash
28+
npm install @coreui/vue@next
1929
```
20-
</br>
2130

2231
### Registering components
2332
```js
@@ -40,9 +49,9 @@ export default {
4049
...
4150
}
4251
```
43-
</br>
4452

4553
### Registering directives
54+
4655
```js
4756
// Registering single directives
4857
import { CEmitRootEvent, CTooltip } from '@coreui/vue';
@@ -59,24 +68,24 @@ export default {
5968
...
6069
}
6170
```
62-
</br>
6371

6472
### Optimization
73+
6574
Components are imported from CommonJS module by default, if you want to use only specific components you can import them from source to enable treeshaking.
6675

6776
```js
6877
// Import components this way to allow tree shaking
6978
import { CDataTable } from '@coreui/vue/src';
7079
```
7180

72-
## Changelog
81+
### Changelog
7382

7483
See the GitHub [release history](https://github.com/coreui/coreui-vue/releases).
7584

76-
## Contributing
85+
### Contributing
7786

7887
See [CONTRIBUTING.md](https://github.com/coreui/coreui-vue/blob/v3-next/CONTRIBUTING.md).
7988

80-
## Credits
89+
### Credits
8190

8291
Some design ideas and solutions in this library are inspired by [Bootstrap-Vue library](https://bootstrap-vue.js.org/)

0 commit comments

Comments
 (0)