Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Brent Ertz committed Jan 6, 2014
1 parent 6d1c930 commit bdfe868
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
Scapegoat
=========

A small library providing utility methods to `escape` and `unescape` HTML entities
A minimal node module providing utility methods to `escape` and `unescape` HTML entities

## Installation

```shell
npm install scapegoat --save
```

## Usage

```js
var scapegoat = require('scapegoat')
escape = scapegoat.escape,
unescape = scapegoat.unescape;
Expand All @@ -18,10 +21,13 @@ A small library providing utility methods to `escape` and `unescape` HTML entiti
unescaped = unescape(escaped);

console.log('html', html, 'escaped', escaped, 'unescaped', unescaped);
```

## Tests

npm test
```shell
npm test
```

## Contributing

Expand Down

0 comments on commit bdfe868

Please sign in to comment.