Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 1.4 KB

README.md

File metadata and controls

37 lines (28 loc) · 1.4 KB

Grayscale favicon Build Status npm

Grayscale favicon is tool that convert colorfull favicon to grayscale.

Code was taken from Ruby Environment Favicon and adopted for npm, yarn, bower.

Example of usage, normal and grayscaled icon with library:

img img

Installation

Several installation options are available:

  • install with npm: npm install grayscale-favicon@1.0.0
  • install with yarn: yarn add grayscale-favicon@1.0.0
  • install with bower: bower install grayscale-favicon@1.0.0

Usage

If you use node.js builder:

import GrayscaleFavicon from 'grayscale-favicon';
// var GrayscaleFavicon = require('grayscale-favicon');

GrayscaleFavicon();

If you use bower or just want to load file from source in html:

<script src="/path/to/grayscale-favicon.js" type="text/javascript"></script>
<script>
  window.GrayscaleFavicon.icon();
</script>

License

The gem is available as open source under the terms of the MIT License.