1
0
mirror of https://github.com/coreui/coreui-icons.git synced 2025-08-24 01:02:53 +02:00
Files
coreui-icons/README.md
2018-05-22 14:02:57 +02:00

47 lines
1.4 KiB
Markdown
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# CoreUI Icons - Simply beautiful open source icons
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..
## Preview & Docs
[https://coreui.io/icons/](https://coreui.io/icons/)
## Installation
### CDN
```html
<link rel="stylesheet" href="https://unpkg.com/@coreui/icons/css/coreui-icons.min.css">
```
### NPM
```shell
npm install @coreui/icons --save
```
Or, you can also clone or [download this repository](https://github.com/coreui/coreui-icons/archive/master.zip) as zip.
## Basic Use
You can place CoreUI Icons just about anywhere using a CSS style prefix and the icons name. CoreUI Icons are designed to be used with inline elements ex. `<i>` or `<span>`.
```html
<i class="cui-energy"></i>
```
## License
CoreUI Icons Free is free, open source, and GPL friendly. You can use it for
commercial projects, open source projects, or really almost whatever you want.
- Icons — CC BY 4.0 License
- In the CoreUI Icons Free download, the CC BY 4.0 license applies to all icons packaged as .svg and .js files types.
- Fonts — SIL OFL 1.1 License
- In the CoreUI Icons Free download, the SIL OLF license applies to all icons packaged as web and desktop font files.
- Code — MIT License
- In the CoreUI Icons Free download, the MIT license applies to all non-font and non-icon files.