archive-gh-me/blob-util
1
0
Fork 0
mirror of https://github.com/nolanlawson/blob-util.git synced 2025-12-08 19:46:19 +00:00
Code Issues Projects Releases Wiki Activity

moar readme

Browse Source
This commit is contained in:
Nolan Lawson 2014-10-25 13:11:54 -04:00
parent 40b2c0b3bf
commit f4982f5f0c
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -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! 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 API
------- -------
@ -237,16 +239,12 @@ Convert a <code>Blob</code> to an <code>ArrayBuffer</code>. Returns a Promise.
**Returns**: `Promise` - Promise that resolves with the <code>ArrayBuffer</code> **Returns**: `Promise` - Promise that resolves with the <code>ArrayBuffer</code>
Building the library Building the library
---- ----
npm install npm install
npm run build 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/`: To generate documentation in `doc/`:
npm run jsdoc npm run jsdoc
@ -255,6 +253,7 @@ or in markdown format as `api.md`
npm run jsdoc2md npm run jsdoc2md
The playground is just `jsdoc` with some extra text containing Kirby and the code samples and such.
Testing the library Testing the library
---- ----