README.md

faviconize

Library and CLI for generating favicons in all formats

Motivation

I wanted to create simpler and more intuitive replacement for existing project with the same purpose - Real Favicon Generator. RFG is really good project but sadly it works only online, its API for Node.js makes HTTP requests under the hood instead of working locally and whole generator seems a little bit overcomplicated for me, personally.

faviconize repository contains both CLI application and library source.

Library ·

Installing

npm i faviconize -S

You will probably want to install it as devDependency :D

Usage

import { faviconize } from 'faviconize'

async function run() {
  await faviconize('path/to/image.jpg')
  // ... or with custom output icon types
  await faviconize('path/to/other-image.jpg', ['apple-touch-icon', 'msapplication-TileImage'])
  // ... or with all icon types and custom output directory
  await faviconize('path/to/another-image.jpg', null, '.')
}

run()

CLI ·

Installing

npm i faviconize-cli -g

Usage

Run faviconize <path-to-icon> in your terminal

Ending speech

This project is licensed under the MIT license. All contributions are welcome.