Contents

# Favicon Maker for Rails

Forked. [Original gem](https://github.com/awmichel/favicon_maker_rails)

This is a very simple gem that adds a rake task to your Rails project for generating favicons of various sizes and formats from a single source file by making use of the [FaviconMaker](https://github.com/follmann/favicon_maker) library.

## Install

Add the following line to your Gemfile:
```
  gem 'ack_favicon_maker_rails'
```

## Usage

1. Place your PNG favicon* in app/assets/images, calling it favicon.png.
2. Type `rake favicon` or `rake favicon:generate[%namespace%]` in your terminal. 
%namespace% need if you want to place in public/%namespace%. So source path will be app/assets/images/%namespace%. 
Also gem try get %namespace%::Engine.root. Rails.root as fallback.
You can use it for subdomains or whatever.
3. Your generated favicons will be output into your public directory .

*: The largest size used is 228x228 for Apple Retina displays, I recommend using an image this size or larger for best results.

## TODO

* Add options for customizing source and output directories?
* Allow additional output options.

## Copyright

Copyright (c) 2017 Alexander Kiseliev. See LICENSE for details.

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
ack_favicon_maker_rails-1.0.3	README.md