Skip to content

Commit

Permalink
Merge pull request #9 from jvdub/master
Browse files Browse the repository at this point in the history
Updating readme to reflect changes made in #8.
  • Loading branch information
gmemstr authored Oct 9, 2018
2 parents a746f82 + b56f712 commit 5bdccc3
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ npm install --save no-swears
const noswears = require('no-swears')
```

### filter(string, callback)
### filterSwearWords(string, callback)

This is the most basic filtering function, and requires the offending
string and a callback, returning the cleaned up string to the program.

```javascript
let badString = "this is a bitching string"

noswears.filter(badString, goodString => {
noswears.filterSwearWords(badString, goodString => {
console.log(goodString) // "this is a ****ing string"
})
```
Expand Down

0 comments on commit 5bdccc3

Please sign in to comment.