Update readme

Author: Philipp Alferov

docs/index.html

@@ -22,28 +22,33 @@ <h2 class="project-tagline">An AngularJS service that provides cross-browser com
   <section class="main-content">
 
     <!-- inject:html -->
-    <h1 id="angular-file-saver-build-status-https-travis-ci-org-alferov-angular-file-saver-svg-https-travis-ci-org-alferov-angular-file-saver-">Angular File Saver <a href="https://travis-ci.org/alferov/angular-file-saver"><img src="https://travis-ci.org/alferov/angular-file-saver.svg" alt="Build Status"></a></h1>
+    <h1 id="angular-file-saver">Angular File Saver</h1>
+<p><a href="https://npmjs.org/package/angular-file-saver"><img src="https://img.shields.io/npm/v/angular-file-saver.svg?style=flat-square" alt="NPM version"></a>
+<a href="https://travis-ci.org/alferov/angular-file-saver"><img src="https://img.shields.io/travis/alferov/angular-file-saver.svg?style=flat-square" alt="Build Status"></a>
+<a href="https://david-dm.org/alferov/angular-file-saver"><img src="https://david-dm.org/alferov/angular-file-saver.svg?style=flat-square" alt="Dependency Status"></a></p>
 <blockquote>
 <p>Angular File Saver is an AngularJS service that leverages
 <a href="https://github.com/eligrey/FileSaver.js/">FileSaver.js</a> and
 <a href="https://github.com/eligrey/Blob.js/">Blob.js</a> to implement the HTML5 W3C
-saveAs() interface in browsers that do not natively support it.</p>
+saveAs() interface in browsers that do not natively support it</p>
 </blockquote>
 <h2 id="dependencies">Dependencies</h2>
 <ul>
-<li><a href="https://github.com/angular/angular.js">AngularJS</a></li>
+<li><a href="https://github.com/angular/angular.js">Angular</a></li>
 <li><a href="https://github.com/eligrey/FileSaver.js/">FileSaver.js</a></li>
 <li><a href="https://github.com/eligrey/Blob.js/">Blob.js</a></li>
 </ul>
 <p>File <code>dist/angular-file-saver.bundle.js</code> contains all required dependencies and
 grants access to both <code>Blob.js</code> and <code>FileSaver.js</code> polyfills via <code>Blob</code> and
 <code>SaveAs</code> services.</p>
 <h2 id="installation">Installation</h2>
-<p>Using bower:</p>
-<pre><code>$ bower install angular-file-saver
-</code></pre><p>Using npm:</p>
-<pre><code>$ npm install angular-file-saver
-</code></pre><h2 id="basic-usage">Basic usage</h2>
+<pre><code class="lang-sh"># Using bower:
+$ bower install angular-file-saver
+
+# Using npm:
+$ npm install angular-file-saver
+</code></pre>
+<h2 id="basic-usage">Basic usage</h2>
 <ul>
 <li>Include the <code>ngFileSaver</code> module into your project;</li>
 <li>Pass both <code>FileSaver</code> and <code>Blob</code> services as dependencies;</li>
@@ -57,9 +62,26 @@ <h2 id="installation">Installation</h2>
 </ul>
 </li>
 </ul>
+<p><a href="http://alferov.github.io/angular-file-saver/#demo">Demo</a></p>
+<h2 id="api">API</h2>
+<h3 id="-filesaver-"><code>FileSaver</code></h3>
+<h4 id="-saveas-data-filename-disableautobom-"><code>#saveAs(data, filename[, disableAutoBOM])</code></h4>
+<p>Immediately starts saving a file</p>
+<h4 id="parameters">Parameters</h4>
+<ul>
+<li><strong>Blob</strong> <code>data</code>: a Blob instance;</li>
+<li><strong>String</strong> <code>filename</code>: Custom filename (extension is optional);</li>
+<li><strong>Boolean</strong> <code>disableAutoBOM</code> : (optional) Disable automatically provided Unicode text encoding hints;</li>
+</ul>
+<h3 id="-blob-blobparts-options-"><code>Blob(blobParts[, options]))</code></h3>
+<p>An Angular factory that returns a Blob instance.
+<a href="https://developer.mozilla.org/en/docs/Web/API/Blob">Blob API on MDN</a></p>
+<h3 id="-saveas-data-filename-disableautobom-"><code>SaveAs(data, filename[, disableAutoBOM])</code></h3>
+<p>An Angular factory that returns a FileSaver.js <code>saveAs</code> polyfill.
+<a href="https://github.com/eligrey/FileSaver.js/#syntax">FileSaver.js documentationruvy</a></p>
 <h2 id="example">Example</h2>
 <p><strong>JS</strong></p>
-<pre><code class="lang-js">function ExampleCtrl($timeout, FileSaver, Blob) {
+<pre><code class="lang-js">function ExampleCtrl(FileSaver, Blob) {
   var vm = this;
 
   vm.val = {
@@ -68,7 +90,7 @@ <h2 id="example">Example</h2>
 
   vm.download = function(text) {
     var data = new Blob([text], { type: &#39;text/plain;charset=utf-8&#39; });
-    $timeout(FileSaver.saveAs.bind(FileSaver, data, &#39;text.txt&#39;), 100);
+    FileSaver.saveAs(data, &#39;text.txt&#39;);
   };
 }
 
@@ -80,7 +102,6 @@ <h2 id="example">Example</h2>
 <pre><code class="lang-html">&lt;div class=&quot;wrapper&quot; ng-controller=&quot;ExampleCtrl as vm&quot;&gt;
   &lt;textarea
     ng-model=&quot;vm.val.text&quot;
-    ng-model-options=&quot;{ getterSetter: true }&quot;
     name=&quot;textarea&quot; rows=&quot;5&quot; cols=&quot;20&quot;&gt;
       Hey ho let&#39;s go!
   &lt;/textarea&gt;
@@ -89,8 +110,8 @@ <h2 id="example">Example</h2>
   &lt;/a&gt;
 &lt;/div&gt;
 </code></pre>
-<h2 id="demo">Demo</h2>
-<p><a href="http://alferov.github.io/angular-file-saver/#demo">Demo on <code>gh-pages</code></a></p>
+<h2 id="license">License</h2>
+<p>MIT © <a href="https://github.com/alferov">Philipp Alferov</a></p>
 
     <!-- endinject -->
 

readme.md

@@ -1,13 +1,16 @@
-Angular File Saver [![Build Status](https://travis-ci.org/alferov/angular-file-saver.svg)](https://travis-ci.org/alferov/angular-file-saver)
-=========
+# Angular File Saver
+
+[![NPM version][npm-image]][npm-url]
+[![Build Status][travis-image]][travis-url]
+[![Dependency Status][depstat-image]][depstat-url]
 
 > Angular File Saver is an AngularJS service that leverages
 [FileSaver.js](https://github.com/eligrey/FileSaver.js/) and
 [Blob.js](https://github.com/eligrey/Blob.js/) to implement the HTML5 W3C
-saveAs() interface in browsers that do not natively support it.
+saveAs() interface in browsers that do not natively support it
 
 ## Dependencies
-- [AngularJS](https://github.com/angular/angular.js)
+- [Angular](https://github.com/angular/angular.js)
 - [FileSaver.js](https://github.com/eligrey/FileSaver.js/)
 - [Blob.js](https://github.com/eligrey/Blob.js/)
 
@@ -16,12 +19,12 @@ grants access to both `Blob.js` and `FileSaver.js` polyfills via `Blob` and
 `SaveAs` services.
 
 ## Installation
-Using bower:
-```
+
+```sh
+# Using bower:
 $ bower install angular-file-saver
-```
-Using npm:
-```
+
+# Using npm:
 $ npm install angular-file-saver
 ```
 
@@ -36,10 +39,30 @@ as the second one: `new Blob(['text'], { type: 'text/plain;charset=utf-8' })`;
   - `filename` **String**: Custom filename (extension is optional);
   - `disableAutoBOM` **Boolean**: (optional) Disable automatically provided Unicode text encoding hints;
 
+[Demo](http://alferov.github.io/angular-file-saver/#demo)
+
+## API
+### `FileSaver`
+#### `#saveAs(data, filename[, disableAutoBOM])`
+Immediately starts saving a file
+
+#### Parameters
+- **Blob** `data`: a Blob instance;
+- **String** `filename`: Custom filename (extension is optional);
+- **Boolean** `disableAutoBOM` : (optional) Disable automatically provided Unicode text encoding hints;
+
+### `Blob(blobParts[, options]))`
+An Angular factory that returns a Blob instance.
+[Blob API on MDN](https://developer.mozilla.org/en/docs/Web/API/Blob)
+
+### `SaveAs(data, filename[, disableAutoBOM])`
+An Angular factory that returns a FileSaver.js `saveAs` polyfill.
+[FileSaver.js documentationruvy](https://github.com/eligrey/FileSaver.js/#syntax)
+
 ## Example
 **JS**
 ```js
-function ExampleCtrl($timeout, FileSaver, Blob) {
+function ExampleCtrl(FileSaver, Blob) {
   var vm = this;
 
   vm.val = {
@@ -62,7 +85,6 @@ angular
 <div class="wrapper" ng-controller="ExampleCtrl as vm">
   <textarea
     ng-model="vm.val.text"
-    ng-model-options="{ getterSetter: true }"
     name="textarea" rows="5" cols="20">
       Hey ho let's go!
   </textarea>
@@ -71,5 +93,15 @@ angular
   </a>
 </div>
 ```
-## Demo
-[Demo on `gh-pages`](http://alferov.github.io/angular-file-saver/#demo)
+
+## License
+MIT © [Philipp Alferov](https://github.com/alferov)
+
+[npm-url]: https://npmjs.org/package/angular-file-saver
+[npm-image]: https://img.shields.io/npm/v/angular-file-saver.svg?style=flat-square
+
+[travis-url]: https://travis-ci.org/alferov/angular-file-saver
+[travis-image]: https://img.shields.io/travis/alferov/angular-file-saver.svg?style=flat-square
+
+[depstat-url]: https://david-dm.org/alferov/angular-file-saver
+[depstat-image]: https://david-dm.org/alferov/angular-file-saver.svg?style=flat-square