diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..685a7be --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,75 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at ben@benjamincharity.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ + diff --git a/README.md b/README.md index 674c798..d877c35 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,97 @@ -# Angular URL-Encode Filter +# angular-url-encode + +[![MIT License][license_image]][license_url] [![NPM version][npm_version_image]][npm_url] + +: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 + +``` + +Add `bc.AngularUrlEncode` to your module's dependencies: + +```javascript angular.module('myModule', ['bc.AngularUrlEncode']); ``` ## Usage -__coming soon__ +#### HTML + +As a filter in the DOM: + +```html +

{{ myPlainString | bcEncode }}

+

{{ encodedString | bcDecode }}

+``` + +#### JavaScript +Using the `$filter` service: -## Demo +```javascript +// Encode +this.encodedString = $filter('bcEncode')(this.myPlainString); -__coming soon__ +// Decode +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 + +- - - + + +[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 + diff --git a/bower.json b/bower.json index cdeed58..731f85d 100644 --- a/bower.json +++ b/bower.json @@ -29,6 +29,5 @@ "node_modules", "package.json", "webpack.config.js" - ], - "version": "0.1.0" + ] } diff --git a/package.json b/package.json index f0d094e..cf92c8b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "angular-url-encode", - "version": "0.1.0", + "version": "1.0.0", "description": "A simple Angular filter to URL-encode a string.", "main": "dist/angular-url-encode.js", "scripts": { diff --git a/src/encode.filter.js b/src/encode.filter.js index 4a1cf08..242635c 100644 --- a/src/encode.filter.js +++ b/src/encode.filter.js @@ -13,7 +13,7 @@ export function EncodeFilter( * @return {String} output */ function encode(input) { - return $window.encodeURIComponent(input); + return $window.encodeURI(input); } }