Skip to content

Remove duplicate text in README.md #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brampono wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Remove duplicate text in README.md #7

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
def9b9c
Remove repeated text
brampono Apr 26, 2023
21e475a
Update subsequent numbers
brampono Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 3 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,17 +120,7 @@ console.log(profanity.isProfane("Don't be an asshole"));
// log: false
```

### 6. Check if the string contains any swear words
Function `.isProfane()` return `True` if any words in the given string has a word existing in the wordlist.

```js
let dirtyText = "That l3sbi4n did a very good H4ndjob.";

console.log(profanity.isProfane(dirtyText));
// log: true
```

### 7. Language support
### 6. Language support
The lib supports two languages they are Brazilian Portuguese and English, the defaults are Portuguese and to change this, see below.

```js
Expand All @@ -148,7 +138,7 @@ console.log(profanity.censor());

> The `config` Object will be overwritten the default values.

### 8. Overrides placeHolder
### 7. Overrides placeHolder
To use a custom placeHolder, just overwritten the default value with a config Object.

```js
Expand All @@ -164,7 +154,7 @@ console.log(profanity.censor());
// log: ---- this ----
```

### 9. Overrides default dictionary
### 8. Overrides default dictionary
To overrides the default profane dictionary, just set the new `Array` of words in config Object.

```js
Expand Down