From f4982f5f0c59dbdf5c8b9e6d415c98dc8ebc97ab Mon Sep 17 00:00:00 2001 From: Nolan Lawson Date: Sat, 25 Oct 2014 13:11:54 -0400 Subject: [PATCH] moar readme --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 67468e8..a53049c 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,8 @@ document.body.appendChild(newImg); So now we have two Kirbys - one with a normal URL, and the other with a blob URL. Neato! +You can try this out yourself in the [blob-util playground](http://blob-util.github.io). Super fun! + API ------- @@ -237,16 +239,12 @@ Convert a Blob to an ArrayBuffer. Returns a Promise. **Returns**: `Promise` - Promise that resolves with the ArrayBuffer - - - Building the library ---- + npm install npm run build -Your plugin is now located at `dist/pouchdb.mypluginname.js` and `dist/pouchdb.mypluginname.min.js` and is ready for distribution. - To generate documentation in `doc/`: npm run jsdoc @@ -255,6 +253,7 @@ or in markdown format as `api.md` npm run jsdoc2md +The playground is just `jsdoc` with some extra text containing Kirby and the code samples and such. Testing the library ----