Skip to content

Commit 2a8132c

Browse files
committed
docs: update README
1 parent 5c3dd97 commit 2a8132c

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### [@coreui/icons-react](https://coreui.io/) for [CoreUI for React](https://coreui.io/react/)
1+
### [@coreui/icons-react](https://icons.coreui.io/) for [CoreUI for React](https://coreui.io/react/)
22

33
[![npm package][npm-badge]][npm]
44
[![NPM downloads][npm-download]][npm]
@@ -19,6 +19,13 @@ npm install @coreui/icons
1919
npm install @coreui/icons-react
2020
```
2121

22+
or
23+
24+
```bash
25+
yarn add @coreui/icons
26+
yarn add @coreui/icons-react
27+
```
28+
2229
##### import:
2330
```jsx
2431
import { CIcon } from '@coreui/icons-react';
@@ -41,23 +48,11 @@ render() {
4148
}
4249
...
4350
```
44-
45-
---
46-
47-
- bootstrapped with [nwb](https://github.com/insin/nwb) toolkit
48-
49-
##### `npm run` scripts
51+
##### scripts:
5052
5153
`package.json` is configured with `"scripts"` we can use with `npm run` while developing the project.
5254
5355
Command | Description |
5456
--- | ---
55-
`npm run build` | prepare for publishing to npm
56-
`npm run clean` | delete built resources
57-
`npm test` | run tests
58-
`npm run test:coverage` | run tests and produce a code coverage report in `coverage/`
59-
<del>`npm run test:watch`</del> | n/a ~~start a test server and re-run tests on every change~~
60-
<del>`npm start`</del> | n/a ~~start a development server for the demo app~~
61-
62-
#### see also:
63-
- [Developing React Components and Libraries with nwb](https://github.com/insin/nwb/blob/master/docs/guides/ReactComponents.md#developing-react-components-and-libraries-with-nwb)
57+
`yarn build` | prepare for publishing to npm
58+
`yarn lint` | run eslint

0 commit comments

Comments
 (0)