Skip to content

Commit

Permalink
docs(readme): update "Example usage for npm" and "CMD" sections
Browse files Browse the repository at this point in the history
  • Loading branch information
jojoee committed Nov 7, 2022
1 parent 8b8d3c7 commit 2b4968e
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,15 @@ var filter = require('leo-profanity');

// output: I have ****, etc.
filter.clean('I have boob, etc.');

// replace current dictionary with the french
filter.loadDictionary('fr');

// create new dictionary
filter.addDictionary('th', ['หนึ่ง', 'สอง', 'สาม', 'สี่', 'ห้า'])
```

See more here [LeoProfanity.clean](https://jojoee.github.io/leo-profanity/doc/LeoProfanity.html#.clean)
See more here [LeoProfanity - Documentation](https://jojoee.github.io/leo-profanity/doc/LeoProfanity.html)

## Algorithm

Expand Down Expand Up @@ -131,6 +137,11 @@ Disadvantage:
## CMD

```
npm run test.watch
npm run validate
npm run doc.generate
# test npm publish
npm publish --dry-run
```

Expand Down

0 comments on commit 2b4968e

Please sign in to comment.