https://github.com/neg4n/faviconize

🎆 Library and CLI responsible for generating favicons in all formats and providing easy way to integrate them into your application
https://github.com/neg4n/faviconize

cli favicon favicon-generator favicons icon icons image-processing web-icons webdev webdevelopment

Last synced: 16 days ago
JSON representation

🎆 Library and CLI responsible for generating favicons in all formats and providing easy way to integrate them into your application

• Host: GitHub
• URL: https://github.com/neg4n/faviconize
• Owner: neg4n
• License: mit
• Created: 2021-08-23T21:06:41.000Z (over 3 years ago)
• Default Branch: development
• Last Pushed: 2021-09-11T06:07:58.000Z (over 3 years ago)
• Last Synced: 2025-01-03T18:56:07.001Z (19 days ago)
• Topics: cli, favicon, favicon-generator, favicons, icon, icons, image-processing, web-icons, webdev, webdevelopment
• Language: TypeScript
• Homepage:
• Size: 546 KB
• Stars: 13
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://realfavicongenerator.net).

RFG is really good project but sadly it works only online, its [API](https://github.com/RealFaviconGenerator/rfg-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 · [![version](https://badgen.net/npm/v/faviconize)](https://www.npmjs.com/package/faviconize) [![types](https://badgen.net/npm/types/faviconize)](https://www.npmjs.com/package/faviconize) [![codecov](https://codecov.io/gh/neg4n/faviconize/branch/main/graph/badge.svg?token=NJRF3CG3W0)](https://codecov.io/gh/neg4n/faviconize)

### Installing

```shell

npm i faviconize -S

```

_You will probably want to install it as devDependency :D_

### Usage

```js

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 · [![version](https://badgen.net/npm/v/faviconize-cli)](https://www.npmjs.com/package/faviconize-cli)

### Installing

```shell

npm i faviconize-cli -g

```

### Usage

Run `faviconize ` in your terminal

## Ending speech

This project is licensed under the MIT license.

All contributions are welcome.