icon/README.markdown

Convert an image to thumbnails suitable for favicon, metro tiles, touch icons.

icon
===

Convert an image to thumbnails suitable for favicon, metro tiles, touch icons.

Dependencies
---

Requires [http://cairographics.org/](http://cairographics.org/) which can be installed
using `brew install` on OS X.

Install
---

```
npm install -g icon
```

Usage
---

```
icon original.png
ls | select name

Name
----
favicon.ico
favicon.png
original.png
touch-icon-ipad-retina.png
touch-icon-iphone-retina.png
touch-icon-iphone.png
tileicon.png
```

Types
---

<table>
    <tr>
        <th>Name</th>
        <th>Type</th>
        <th>Size</th>
    </tr>
    <tr>
        <td>touch-icon-iphone.png</td>
        <td>PNG</td>
        <td>57 x 57</td>
    </tr>
    <tr>
        <td>touch-icon-iphone-retina.png</td>
        <td>PNG</td>
        <td>114 x 114</td>
    </tr>
    <tr>
        <td>touch-icon-ipad-retina.png</td>
        <td>PNG</td>
        <td>144 x 144</td>
    </tr>
    <tr>
        <td>favicon.png</td>
        <td>PNG</td>
        <td>96 x 96</td>
    </tr>
    <tr>
        <td>favicon.ico</td>
        <td>ICO</td>
        <td>64 x 64</td>
    </tr>
    <tr>
        <td>tileicon.png</td>
        <td>PNG</td>
        <td>144 x 144</td>
    </tr>
</table>

Adding to your website
---

See [Jonathan T. Neal: Understand the Favicon](http://www.jonathantneal.com/blog/understand-the-favicon/)

License
---

MIT