📝 update docs

- match doc format
- added npm and license badges
- switched to CodePen demos
- added TOC

Author: benjamincharity

README.md

@@ -1,45 +1,85 @@
-# Angular URL-Encode Filter
+# angular-url-encode
 
-A simple Angular filter to encode or decode a string using `encodeURI` and `decodeURI`.
+[![MIT License][license_image]][license_url] [![NPM version][npm_version_image]][npm_url]
 
-[**Demo on Plunker**](http://plnkr.co/edit/oPJZWt?p=preview)
+:arrows_counterclockwise: A simple Angular filter to URL-encode or decode a string using `encodeURI`
+and `decodeURI`.
+
+> [**:tv: Demo**][demo]
+
+_[Comments and Pull Requests welcome!][issues]_
+
+---
+
+## Contents
+
+- [Installation](#installation)
+- [Dependencies](#dependencies)
+- [Usage](#usage)
+- [Development](#development)
+
+## Dependencies
+
+- AngularJS (^1.4.0)
 
 
 ## Installation
 
-`$ bower install angular-url-encode --save`
+#### NPM
 
-Add `bc.AngularUrlEncode` to your module's dependencies:
+```bash
+$ npm install angular-url-encode --S
+```
 
+#### Bower
+
+```bash
+$ bower install angular-url-encode --S
 ```
+
+#### Manually
+
+Add the script and styles to your HTML:
+
+```html
+<script src="../path/to/angular-url-encode/dist/angular-url-encode.js"></script>
+```
+
+Add `bc.AngularUrlEncode` to your module's dependencies:
+
+```javascript
 angular.module('myModule', ['bc.AngularUrlEncode']);
 ```
 
 
 ## Usage
 
+#### HTML
+
 As a filter in the DOM:
 
-```
-{{ myPlainString | bcEncode }}
-{{ encodedString | bcDecode }}
+```html
+<p>{{ myPlainString | bcEncode }}</p>
+<p>{{ encodedString | bcDecode }}</p>
 ```
 
-Using the `$filter` service in JS:
+#### JavaScript
 
-```
+Using the `$filter` service:
+
+```javascript
 // Encode
-this.encodedString = $filter('bcEncode')(myPlainString);
+this.encodedString = $filter('bcEncode')(this.myPlainString);
 
 // Decode
-this.decodedString = $filter('bcDecode')(encodedString);
+this.decodedString = $filter('bcDecode')(this.encodedString);
 ```
 
 
 - - -
 
 
-### Development Scripts
+## Development
 
 * `npm run build` - produces production version of your library under the `dist` folder
 * `npm run dev` - produces development version of your library and runs a watcher
@@ -48,6 +88,10 @@ this.decodedString = $filter('bcDecode')(encodedString);
 - - -
 
 
-[All idea and code contributions
-welcome!](https://github.com/benjamincharity/angular-url-encode/issues)
+[demo]: http://codepen.io/benjamincharity/pen/wzyNqQ?editors=1000
+[issues]: https://github.com/benjamincharity/angular-url-encode/issues
+[license_image]: http://img.shields.io/badge/license-MIT-blue.svg
+[license_url]: LICENSE
+[npm_url]: https://npmjs.org/package/angular-url-encode
+[npm_version_image]: http://img.shields.io/npm/v/angular-url-encode.svg