Skip to content

Commit

Permalink
Updated documentation
Browse files Browse the repository at this point in the history
Added note on installing from github
Fixed spelling mistakes
Reminified
  • Loading branch information
tommoor committed Apr 9, 2016
1 parent 6a4e131 commit ea8e815
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 7 deletions.
21 changes: 15 additions & 6 deletions README.md
@@ -1,14 +1,23 @@
# Tinycon

A small library for manipulating the favicon, in particular adding alert bubbles and changing images. Tinycon gracefully falls back to a number in title approach for browers that don't support canvas or dynamic favicons.
A small library for manipulating the favicon, in particular adding alert bubbles and changing images. Tinycon gracefully falls back to a number in title approach for browsers that don't support canvas or dynamic favicons.

<img src="https://github.com/tommoor/tinycon/blob/master/examples/screenshot.png?raw=true" />

<a href="http://tommoor.github.com/tinycon/">See the Live Demo here.</a>

## Documentation

Tinycon adds a single object to the global namespace and does not require initialisation.
Tinycon adds a single object to the global namespace and does not require initialisation.

### Installation

There are several versions of Tinycon published on NPM, unfortunately they are not controlled by me and do not track HEAD. The best idea is to install from github
directly and cut out the middleman!

```
npm install tommoor/tinycon --save
```

### Basic Usage

Expand All @@ -23,8 +32,8 @@ Tinycon can take a range of options to customise the look
* width: the width of the alert bubble
* height: the height of the alert bubble
* font: a css string to use for the fontface (recommended to leave this)
* colour: the foreground font colour
* background: the alert bubble background colour
* color: the foreground font color
* background: the alert bubble background color
* fallback: should we fallback to a number in brackets for browsers that don't support canvas/dynamic favicons? Boolean, or use the string 'force' to ensure a title update even in supported browsers.
* abbreviate: should tinycon shrink large numbers such as 1000 to an abbreviated version (1k). Boolean, defaults to true

Expand All @@ -33,7 +42,7 @@ Tinycon.setOptions({
width: 7,
height: 9,
font: '10px arial',
colour: '#ffffff',
color: '#ffffff',
background: '#549A2F',
fallback: true
});
Expand All @@ -52,7 +61,7 @@ require([
width: 7,
height: 9,
font: '10px arial',
colour: '#ffffff',
color: '#ffffff',
background: '#549A2F',
fallback: true
});
Expand Down
2 changes: 1 addition & 1 deletion tinycon.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ea8e815

Please sign in to comment.