mirror of https://github.com/atisawd/boxicons.git synced 2024-11-13 19:04:52 +01:00

High Quality web friendly icons

Find a file

atisawd b2a0c419a6 b		2018-06-18 17:32:05 +05:30
src	Initial commit	2018-06-15 13:20:17 +05:30
static	b	2018-06-18 17:32:05 +05:30
.babelrc	Initial commit	2018-06-15 13:20:17 +05:30
.eslintrc.json	Initial commit	2018-06-15 13:20:17 +05:30
.gitignore	Initial commit	2018-06-15 13:20:17 +05:30
.nojekyll	Initial commit	2018-06-15 13:20:17 +05:30
404.html	analytics	2018-06-17 21:47:17 +05:30
CNAME	cname-change	2018-06-15 14:01:15 +05:30
index.html	b	2018-06-18 17:32:05 +05:30
LICENSE	Update LICENSE	2018-06-15 15:24:19 +05:30
package-lock.json	Initial commit	2018-06-15 13:20:17 +05:30
package.json	Initial commit	2018-06-15 13:20:17 +05:30
README.md	b	2018-06-18 17:32:05 +05:30
webpack.config.js	Initial commit	2018-06-15 13:20:17 +05:30

README.md

BoxIcons

High Quality web friendly icons

'Boxicons' is a carefully designed open source iconset with 350+ icons. It's crafted to look enrich your website/app experience. You can check out all the icons here!

Installation

To install via npm, simply do the following:

$ npm install boxicons --save

Usage

Include the stylesheet on your document's <head>

<head>
  <link rel="stylesheet" href="boxicons.min.css">
</head>

Instead of installing you may use the remote version

<head>
  <link rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/boxicons@1.0.5/css/boxicons.min.css">
  <!-- or -->
  <link rel="stylesheet"
  href="https://unpkg.com/boxicons@1.0.5/css/boxicons.min.css">
</head>

To use an icon on your page, add a class 'bx' and seperate class with the icons name with a prefix 'bx-':

<i class="bx bx-hot"></i>

Check out all the icons here!

License

Boxicons is licensed under the MIT license. (http://opensource.org/licenses/MIT)

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