0.2.0 • Published 6 years ago
captain-icons v0.2.0
Captain Icons
A npm package that easily provides the awesome Captain Icon's +350 FREE vector icons to empower your mobile and designs.
Installation
1. Add the library to your project
$ npm i captain-icon
$ yarn add captain-icon2. Reference the fonts on the HTML's head
<head>
<link href="path/to/dist/captain-icons.css" rel="stylesheet">
</head>Usage
<i class="cap-icon ci-camera"></i>Cheat Sheet
For details and embeddings codes, click here.
Configuration
The following variables are allowed to be set externally:
| Variable | Description | Default value |
|---|---|---|
| $captain-icon-selector | Defines main icon selector | cap-icon |
| $captain-icon-slug | Defines the icon selector | ci |
| $captain-icon-font-path | Defines the fonts' path | web-fonts |
How to contribute
- Bug reports and pull requests are welcome on GitHub
- Follow the Semantic Versioning Specification
- Follow the GitHub Flow
- Follow the 5 Useful Tips For A Better Commit Message article and the How to Write a Git Commit Message post
- Use Commitizen cli when committing
Code of Conduct
Everyone interacting in the Captain-Icons project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.
License
The package is available as open source under the terms of the CC BY-SA 4.0.
Copyright
(c) Designed by Mario del Valle. Licensed under the CC BY-SA 4.0.