Permalink
Browse files

Updated readme

  • Loading branch information...
1 parent 65d1a65 commit 5643eadb25b7dbbdf2af61a85841a622c2a86c4a myfreeweb committed Jun 14, 2010
Showing with 11 additions and 0 deletions.
  1. +11 −0 README.md
View
11 README.md
@@ -1,2 +1,13 @@
# dockBadger #
+## About ##
a pure JavaScript solution for adding a dock badge (for Fluid and Mozilla Prism) or just a number to the title of current page (for any browser). Very small and useful for displaying **unread messages count** in mail/chat webapps.
+
+## Usage ##
+in your $(window).load(function(){})/window.onload/etc. init function:
+ dockBadger.init()
+
+when you need to set a number (for example, user receives a message):
+ dockBadger.set(number)
+
+when you need to clear the badge (tip: put this in $('body').hover(function() {})):
+ dockBadger.set(0)

0 comments on commit 5643ead

Please sign in to comment.