# BoxIcons [![GitHub issues](https://img.shields.io/github/issues/atisawd/boxicons.svg)](https://github.com/atisawd/boxicons/issues) [![Twitter](https://img.shields.io/twitter/url/https/github.com/atisawd/boxicons.svg?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=https%3A%2F%2Fgithub.com%2Fatisawd%2Fboxicons) [![Donate](https://img.shields.io/badge/donate-paypal-blue.svg?style=flat-square)](https://paypal.me/atisawd) _High Quality web friendly icons_ 'Boxicons' is a carefully designed open source iconset with 700+ icons. It's crafted to look enrich your website/app experience. _Announcing Boxicons v1.5.1!_ Solid icons have been added with a seperate logos category You can check out the detailed documentation [here](https://boxicons.com/get-started) ## Installation To install via npm, simply do the following: ```bash $ npm install boxicons --save ``` import the module ```javscript import 'boxicons/css/boxicons.css'; ``` ## Usage ### Using via CSS 1. Include the stylesheet on your document's `
` ```html ``` Instead of installing you may use the remote version ```html ``` 2. To use an icon on your page, add a class 'bx' and seperate class with the icons name with a prefix 'bx-' for regular icons , 'bxs-' for solid icons and 'bxl-' for logos: ```html ``` [Check out all the icons here!](https://boxicons.com) ## License [You can read the license here!](https://boxicons.com/get-started#license) ## Contributing Pull requests are the way to go here. I apologise in advance for the slow action on pull requests and issues. Caught a mistake or want to contribute to the documentation? [Edit this page on Github](https://github.com/atisawd/boxicons/blob/master/README.md)