Skip to content
This repository has been archived by the owner on Aug 3, 2020. It is now read-only.

Latest commit

 

History

History
78 lines (46 loc) · 2.42 KB

installation.md

File metadata and controls

78 lines (46 loc) · 2.42 KB

Installation

Available install options:

npm

Install Cryptocoins NPM package:

$ npm i cryptocoins-icons

SVG icons

SVG is better option, if you want to use just a few icons (including whole webfont would be data-inefficient. Find the icons you need in "SVG" folder and copy them to your project. Then use them as regular images:

<img src="img/BTC.svg" alt="Bitcoin">

Tip: You can also open each SVG icon in text editor and copy its contents directly into HTML, resulting in fewer HTTP requests and ability to style icons direcly via CSS. There are also many scripts that do the same automatically – your choice.

When extracted to HTML directly, you can style the icons via CSS like this:

Note: be sure to use SVG's "fill" property instead of "color".

.btc { fill: black; }
.btc:hover { fill: orange; }

You can also include cryptocoins-color.css which contains all the coins' main colors. This stylesheet colors all the icons via fill by default, so edit it as you please.


Webfont version

Ideal when you want to include all icons at once.

Pro tip: if you want to load icons efficiently (only those you need), generate the webfont yourself

First clone or download Cryptocoins and extract its contents.

Webfont is ideal when you want to use majority of Cryptocoins icons. Copy webfont/ folder to your project and link cryptocoins.css in your project (you can optionally include also cryptocoins-colors.css if you want to use predefined colors):

<!-- CSS defining icons (required) -->
<link rel="stylesheet" href="webfont/cryptocoins.css">

<!-- CSS defining icon/coin colors (optional) -->
<link rel="stylesheet" href="webfont/cryptocoins-colors.css">

Then insert your icons in HTML, e.g.:

Cryptocoins targets any element with cc class. You can use <i>, <div> or whatever you want.

<i class="cc BTC"></i>

If you're familiar with Font Awesome, it's pretty much the same.


CDN

Cryptocoins are also hosted on jsDelivr CDN.