Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
absorpheus committed Dec 29, 2021
1 parent dff097c commit cc89c47
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ npm install -s @coffeeandfun/google-profanity-words

## Usage
```js
import { profanityEngine } from '@coffeeandfun/google-profanity-words';
import { ProfanityEngine } from '@coffeeandfun/google-profanity-words';

let profanity = new profanityEngine();
let profanity = new ProfanityEngine();

await profanity.all(); // returns all bad words as an array.
profanity.all(); // returns all bad words as an array.

await profanity.search('bad word'); // returns true if the word is found in the list.
profanity.search('bad word'); // returns true if the word is found in the list.

```

Expand Down

0 comments on commit cc89c47

Please sign in to comment.