Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 3c7e31f

Browse filesBrowse files
committed
docs: readme update
1 parent 07c04b5 commit 3c7e31f
Copy full SHA for 3c7e31f

File tree

2 files changed

+33
-2
lines changed
Filter options

2 files changed

+33
-2
lines changed

‎README.md

Copy file name to clipboardExpand all lines: README.md
+32-1Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,40 @@
77
[npm]: https://www.npmjs.com/package/@coreui/icons-react
88
[npm-download]: https://img.shields.io/npm/dm/@coreui/icons-react.svg?style=flat-square
99

10+
##### install:
11+
```bash
12+
npm install @coreui/react
13+
npm install @coreui/icons-react
14+
```
15+
16+
##### import:
17+
```jsx
18+
import { CIcon, CIconRaw } from '@coreui/icons-react';
19+
import { cifAu } from '@coreui/icons';
20+
```
21+
```scss
22+
@import '~@coreui/icons/css/all.css';
23+
```
24+
25+
##### usage:
26+
```jsx
27+
...
28+
class CoreUIIcons extends Component {
29+
...
30+
render() {
31+
return (
32+
<CIconRaw name='cifAu' size="2xl"/>
33+
<CIcon name="cil-list" size="2xl"/>
34+
)
35+
}
36+
...
37+
```
38+
39+
---
40+
1041
- bootstrapped with [nwb](https://github.com/insin/nwb) toolkit
1142
12-
#### `npm run` scripts
43+
##### `npm run` scripts
1344
1445
`package.json` is configured with `"scripts"` we can use with `npm run` while developing the project.
1546

‎package.json

Copy file name to clipboardExpand all lines: package.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@coreui/icons-react",
3-
"version": "1.0.0-alpha.0",
3+
"version": "1.0.0-alpha.1",
44
"description": "CoreUI Icons React component",
55
"license": "MIT",
66
"homepage": "https://coreui.io",

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.