Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

added readme.markdown

  • Loading branch information...
commit 84aeb220aacee7a4d29965bbcba960c0aac84a5a 1 parent 5a36752
@pkrumins authored
Showing with 31 additions and 0 deletions.
  1. +31 −0 readme.markdown
View
31 readme.markdown
@@ -0,0 +1,31 @@
+# browser-badge
+
+Generate browser version compatibility badges or serve them from cache.
+
+# cache dir must exist
+
+Make sure the cache dir exists. This library doesn't create a cache dir for you.
+
+# methods
+
+``` js
+var browserBadgeCached = require('browser-badge-cached')(cacheDir)
+```
+
+Then use it just like [browser-badge](https://github.com/substack/browser-badge).
+
+## browserBadgeCached(cacheDir)
+
+Return a readable stream of png data from the browser version compatability
+object `browsers`.
+
+`browsers` should map browser names to maps of versions to booleans expressing
+compatbility.
+
+# install
+
+To install the library with [npm](http://npmjs.org) do:
+
+```
+npm install browser-badge-cached
+```
Please sign in to comment.
Something went wrong with that request. Please try again.