# @icon/maki-icons
[](https://www.npmjs.org/package/@icon/maki-icons)
This repository is a module of the full [standard-icons][standard-icons] repository.
## Install
This repository is distributed with [npm]. After [installing npm][install-npm], you can install `@icon/maki-icons` with this command.
```bash
npm install --save @icon/maki-icons
```
## Usage
There are many ways/formats of how to use maki-icons. The fastest and recommended way is via SVG directly. Or use the webfont version if you want to include all icons at once:
### SVG icons -- when you need just a few icons in your project
1 . If you want to use just a few icons. Find the icons you need in "icons" folder. Then use them as regular images:
```
```
2 . Icons can be served from a CDN such as [Unpkg][Unpkg]. Simply use the `@icon/maki-icons` npm package in the URL like the following:
```
```
### Icons font -- ideal when you want to include all icons at once
1 . Install `@icon/maki-icons` with this command. In the `` of your html, reference the location to your `maki-icons.css`.
```
...
...
```
2 . Use [unpkg.com][Unpkg] to load directly maki-icons without installing anything:
```
...
...
```
> Place maki-icons with `` tag in your html like this. Icon class names are to be used with the `cil` class prefix.
```
```
## Bugs, Ideas, Pull Requests
If you have any ideas or found bugs, please send me Pull Requests or let me know with [GitHub Issues][github issues].
## License
maki-icons is copyright by Mapbox, licensed under the [CC0-1.0][./LICENSE].
[SIL]: http://scripts.sil.org/OFL
[standard-icons]: https://github.com/thecreation/standard-icons
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/
[github issues]: https://github.com/thecreation/standard-icons/issues
[Unpkg]: https://unpkg.com
```
2 . Icons can be served from a CDN such as [Unpkg][Unpkg]. Simply use the `@icon/maki-icons` npm package in the URL like the following:
```
```
### Icons font -- ideal when you want to include all icons at once
1 . Install `@icon/maki-icons` with this command. In the `` of your html, reference the location to your `maki-icons.css`.
```
...
...
```
2 . Use [unpkg.com][Unpkg] to load directly maki-icons without installing anything:
```
...
...
```
> Place maki-icons with `` tag in your html like this. Icon class names are to be used with the `cil` class prefix.
```
```
## Bugs, Ideas, Pull Requests
If you have any ideas or found bugs, please send me Pull Requests or let me know with [GitHub Issues][github issues].
## License
maki-icons is copyright by Mapbox, licensed under the [CC0-1.0][./LICENSE].
[SIL]: http://scripts.sil.org/OFL
[standard-icons]: https://github.com/thecreation/standard-icons
[npm]: https://www.npmjs.com/
[install-npm]: https://docs.npmjs.com/getting-started/installing-node
[sass]: http://sass-lang.com/
[github issues]: https://github.com/thecreation/standard-icons/issues
[Unpkg]: https://unpkg.com