😀 Beautiful favicons API.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
example
icons
README.md
config.js
package.json
server.js
update_db.js

README.md

iconbin

  • Google larger site-icons for the gazillion-th time
  • Build a favicon API instead because the standard is outdated
  • Open the API to anyone as a favicon drop-in and design resource

This is the repository for iconbin.com, mapping domain names to beautiful favicons of all variety – accessible as image URLs or via API, driven by the community and made available through a CDN. Iconbin functions as a "shim" or "polyfill" because the favicon standard won't change over night. The goal is to drive adoption of the HTML5 favicon specification. This very much hinges on contributions, so please go ahead. Read more about it here.

How it works

Example: https://iconbin.com/api/google.com

Unlike the few favicon services out there, iconbin does not scrape the favicon.ico. Instead it relies entirely on manual labor to provide nice, large and up-to-date icons via this repository. Borne out of frustration with looking up large site-icons to display news sources, this can be used in functional prototypes or any other templating situation. Throw a domain name at the API and it will yield. This is possible because arbitrary redirects are resolved to display <img> as well as <link rel="icon"> sources in most browsers. For delivery, icons are cached infinitely through MaxCDN. The caveat being that you might not receive updated icons if you use the CDN directly. Instead, you point your sources to iconbin.com/api/foo.com/src, which will redirect to the latest version.

Contributing

To add an icon, please follow these steps:

  1. Place the image file in /res and add its metadata to icons.json.
  2. Icons should be square, measure at least 300 pixels, use a reasonable filetype
  3. Have a filename in the format foo.com.png or xyz.foo.com.jpg, where foo should be the canonical domain name.
  4. Then you reference this canonical icon name in urls.json and map any additional short domains or commonly used CNAME domains to the canonical one, e.g. nyt.com maps to nytimes.com. We disregard www as its just a subdomain.
  5. Before doing the PR you should remember to sync your fork with any changes made upstream. To avoid any collisions, PRs will be processed in the order of their filing.

FAQ

Q: This will not scale! It's a bottleneck!
A: You're right. Favicons need to live at their domains. But if this ever hits technical limits then the case for better favicons is made! At the moment, until we see bottlenecking, icon data is hosted on Github through RawGit, the url mapping is cached through a Node express app in-memory. Github file quotas should allow for the next 5k icons or so.

Q: Why mix different filetypes?
A: As much as we all love SVG and would like for it to be the default, most icons out there are bitmaps. And to be fair, the different file types have their strengths. JPG may be more suited to detailed works while PNG has an alpha channel. A future scenario might be dynamic file types – e.g. WebP over JPEG based on the clients Accept-Content headers.

License

All icon resources in this repository are the property of their respective copyright holders. This is a (1) not-for-profit community driven offering with the sole aim of providing developers with a fast, easy way of displaying brand information in the best way possible and thus having a (2) positive effect on the recognition and potential market of these brands. In summary, this application of copyrighted material should be generally covered by Fair Use or comparable licence doctrines. Iconbin is not intended to be used in commercial environments. Should you find your corporate identity in any way misrepresented, please get in touch ASAP at a@iconbin.com or better still, do a Pull Request with the correct icon data and send us a corresponding license note to be displayed in context of this repository and iconbin.com. The metadata itself is licensed under MIT License (MIT).

[1] [2]

Contact

@___paul