coffeekraken-favicons v1.0.0

Coffeekraken favicons stack

Simply and quickly generate all your favicons using the amazing favicons npm package.

Table of content

1. Install
2. Get Started
3. CLI Options
4. Contribute
5. Who are Coffeekraken?
6. Licence

Install

npm install coffeekraken-favicons-stack --save-dev

Get Started

Use the CLI as follow:

coffeekraken-favicons-stack --source src/img/favicon.png --output public/dist/favicons --html-output public/dist/favicons/favicons.html --path '/public/dist/favicons' --theme '#fff' --background '#fff'

CLI Options

Here's all the CLI options available:

-s|--source

Source file for favicon

• default : src/img/favicon.png

-o|--output

Output folder for generated images paths

• default : dist/favicons

-h|--html-output

File path in which to output the icons HTML

• default : null

-t|--theme

Theme color for browser chrome

• default : #fff

-b|--background

Background color for flattened icons

• default : #fff

-p|--path

Path for overriding default icons path

• default : dist/favicons

Contribute

This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

1. Share the love ❤️
2. Declare issues
3. Fix issues
4. Add features
5. Build web component

Who are Coffeekraken

We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

More on who we are

License

The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...