Commit d9c1b83

committed

added usage and demo to readmy

1 parent a34bbb8 commit d9c1b83Copy full SHA for d9c1b83

File tree

+25

-3

lines changed

+25

-3

lines changed

Lines changed: 25 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,11 @@`
`1`	`1`	`# Angular URL-Encode Filter`
`2`	`2`
`3`	`3`
	`4`	`+## Demo`
	`5`	`+`
	`6`	`+[Plunkr](http://plnkr.co/edit/oPJZWt)`
	`7`	`+`
	`8`	`+`
`4`	`9`	`## Installation`
`5`	`10`
`6`	`11`	`$ bower install angular-url-encode --save`
`@@ -14,12 +19,22 @@ angular.module('myModule', ['bc.AngularUrlEncode']);`
`14`	`19`
`15`	`20`	`## Usage`
`16`	`21`
`17`		`-__coming soon__`
	`22`	`+As a filter in the DOM:`
`18`	`23`
	`24`	+```
	`25`	`+{{ myPlainString \| bcEncode }}`
	`26`	`+{{ encodedString \| bcDecode }}`
	`27`	+```
`19`	`28`
`20`		`-## Demo`
	`29`	+Using the `$filter` service in JS:
`21`	`30`
`22`		`-__coming soon__`
	`31`	+```
	`32`	`+// Encode`
	`33`	`+this.encodedString = $filter('bcEncode')(myPlainString);`
	`34`	`+`
	`35`	`+// Decode`
	`36`	`+this.decodedString = $filter('bcDecode')(encodedString);`
	`37`	+```
`23`	`38`
`24`	`39`
`25`	`40`	`- - -`
`@@ -30,3 +45,10 @@ __coming soon__`
`30`	`45`	* `npm run build` - produces production version of your library under the `dist` folder
`31`	`46`	* `npm run dev` - produces development version of your library and runs a watcher
`32`	`47`
	`48`	`+`
	`49`	`+- - -`
	`50`	`+`
	`51`	`+`
	`52`	`+[All idea and code contributions`
	`53`	`+welcome!](https://github.com/benjamincharity/angular-url-encode/issues)`
	`54`	`+`

Comments

(0)