Skip to content

Commit dd3eb88

Browse files
committed
chore: update component documentation
1 parent 32f5116 commit dd3eb88

File tree

1 file changed

+10
-25
lines changed

1 file changed

+10
-25
lines changed

README.md

+10-25
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,21 @@
1-
# CoreUI Icons - Simply beautiful open source icons
1+
## CoreUI icons vue - CIcon component
22

3-
An open source icon set with marks in SVG, webfont and raster formats. Ready-to-use fonts and stylesheets that work with your favorite frameworks..
3+
Dedicated component used to implement [CoreUI Icons svg set](https://coreui.io/icons/) in Vue.js.
44

5+
## Features
6+
- Can load icons stored globally, directly passed or by source link,
7+
- Can significantly reduce bundle size due to JavaScript named icons import,
8+
- Full functionality of 'svg' html tag,
9+
- Clean API
510

6-
## Preview & Docs
7-
8-
[https://coreui.io/icons/](https://coreui.io/icons/)
9-
11+
For component description visit [CIcon component documentation](https://coreui.io/vue/docs/components/icon)
1012

1113
## Installation
1214

13-
### CDN
14-
15-
```html
16-
<link rel="stylesheet" href="https://unpkg.com/@coreui/icons/css/coreui-icons.min.css">
17-
```
18-
19-
### NPM
15+
If you already have installed [CoreUI Vue component library](https://coreui.io/vue/docs) plugin, then you have CIcon component already installed, otherwise install package by:
2016

2117
```shell
22-
npm install @coreui/icons --save
23-
24-
```
25-
26-
Or, you can also clone or [download this repository](https://github.com/coreui/coreui-icons/archive/master.zip) as zip.
27-
28-
29-
## Basic Use
30-
You can place CoreUI Icons just about anywhere using a CSS style prefix and the icon’s name. CoreUI Icons are designed to be used with inline elements ex. `<i>` or `<span>`.
31-
32-
```html
33-
<i class="cui-energy"></i>
18+
npm install @coreui/icons-vue --save
3419
```
3520

3621
## License

0 commit comments

Comments
 (0)