Skip to content

Commit 18b1384

Browse files
committed
docs: README update
1 parent 080e634 commit 18b1384

File tree

1 file changed

+45
-1
lines changed

1 file changed

+45
-1
lines changed

README.md

+45-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## @coreui/react v3 for [CoreUI 3 for React](https://coreui.io/react/)
1+
# CoreUI React components library
22

33
[![npm package][npm-badge]][npm]
44
[![npm next][npm-next]][npm]
@@ -9,6 +9,50 @@
99
[npm]: https://www.npmjs.com/package/@coreui/react
1010
[npm-download]: https://img.shields.io/npm/dm/@coreui/react.svg?style=flat-square
1111

12+
##### @coreui/react v3 for [CoreUI 3 for React](https://coreui.io/react/)
13+
14+
###### Over 90 bootstrap based React components and directives
15+
16+
##### For library guide please visit our [Documentation site »](https://coreui.io/react/docs)
17+
18+
Check out demo of components usage: [CoreUI React Admin Template »](https://coreui.io/react/demo)
19+
20+
![Template](https://coreui.io/images/github/vue-free-template-3.gif)
21+
22+
### Installation
23+
24+
Before installation you need to install [node and npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) on your machine.
25+
```shell
26+
npm install @coreui/react
27+
```
28+
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://getbootstrap.com/) library
34+
35+
Installation:
36+
```shell
37+
npm install @coreui/coreui
38+
```
39+
40+
Styles usage:
41+
```scss
42+
@import "~@coreui/coreui/scss/coreui";
43+
```
44+
45+
### Changelog
46+
See the GitHub [release history](https://github.com/coreui/coreui-react/releases).
47+
48+
### Contributing
49+
See [CONTRIBUTING.md](https://github.com/coreui/coreui-react/blob/master/CONTRIBUTING.md).
50+
51+
### Credits
52+
Some design ideas and solutions in this library inspired by [reactstrap library](https://reactstrap.github.io/)
53+
54+
55+
---
1256
- bootstrapped with [nwb](https://github.com/insin/nwb) toolkit
1357

1458
#### `npm run` scripts

0 commit comments

Comments
 (0)