Skip to content

Commit 7fa3831

Browse files
committed
chore: update README file
1 parent cc66554 commit 7fa3831

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,27 @@ Check out demo of components usage: [CoreUI Vue Admin Template »](https://coreu
2121

2222
## Installation
2323

24+
Before installation you need to install [node and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) on your machine.
2425
```shell
2526
npm install @coreui/vue
2627
```
2728

29+
### Styling
30+
31+
Components are styled using @coreui/coreui CSS library, but you can use them also with bootstrap CSS library. That is possible because @coreui/coreui library is compatible with bootstrap, it just extends its functionalities. The only exception is custom CoreUI components, which don't exist in the Bootstrap ecosystem (template components, callout, switch).
32+
33+
Styles have to be imported separately! Import [CoreUI](https://github.com/coreui/coreui) CSS library (recommended), or [Bootstrap](https://bootstrap-vue.js.org/) library
34+
35+
Installation:
36+
```shell
37+
npm install @coreui/coreui
38+
```
39+
40+
Basic usage:
41+
```scss
42+
@import "~@coreui/coreui/scss/coreui";
43+
```
44+
2845
### Registering components
2946

3047
```js
@@ -76,6 +93,10 @@ Components are imported from CommonJS module by default, if you want to use only
7693
import { CDataTable } from '@coreui/vue/src';
7794
```
7895

96+
### Code autocompletion
97+
98+
If you are using [VS Code](https://code.visualstudio.com/) editor with Vetur plugin installed, then the editor would display hints for our library (component names and prop names).
99+
79100
### Changelog
80101

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

0 commit comments

Comments
 (0)