docs: add README.md

README.md

@@ -0,0 +1,46 @@
+# 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 icon’s name. CoreUI Icons are designed to be used with inline elements ex. `<i>` or `<span>`.
+
+```html
+<i class="cui-energy"></i>
+```
+
+## License
+
+Font Awesome 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 Font Awesome 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 Font Awesome Free download, the SIL OLF license applies to all icons packaged as web and desktop font files.
+- Code — MIT License
+  - In the Font Awesome Free download, the MIT license applies to all non-font and non-icon files.