Skip to content

Commit a1b0568

Browse files
committed
docs(README.md): Update README.md
1 parent f69fd04 commit a1b0568

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ filter.check('I have BoOb.');
4949
// output: I have ****
5050
filter.clean('I have b00b');
5151

52-
// custom replaceKey
52+
// custom replaceKey (one character only)
5353
// output: I have ++++
5454
filter.clean('I have b00b', '+');
5555

@@ -122,7 +122,7 @@ Disadvantage:
122122
### Filter
123123
```
124124
Attempt 1 (2.1): split into array (or using regex, somehow)
125-
using space to split it into array then check by bad-word list
125+
using space to split it into array then check by profanity word list
126126
Advantage:
127127
- simple
128128
Disadvantage:
@@ -131,18 +131,18 @@ Disadvantage:
131131
e.g. Great tit (https://en.wikipedia.org/wiki/Great_tit)
132132
133133
Attempt 2 (2.2): filter word inside (with or without space)
134-
detect all alphabet that contain "bad word" (e.g. `thistextisfunnyboobsanda55`)
134+
detect all alphabet that contain "profanity word" (e.g. `thistextisfunnyboobsanda55`)
135135
Advantage:
136136
- simple
137-
- can detect "un-spaced" bad word
137+
- can detect "un-spaced" profanity word
138138
Disadvantage:
139139
- many "false positive"
140140
e.g. http://www.morewords.com/contains/ass/
141141
e.g. Clbuttic mistake (filter mistake)
142142
```
143143

144144
Summary
145-
- We don't know all methods that can produce bad word
145+
- We don't know all methods that can produce profanity word
146146
(e.g. how many different ways can you enter a55 ?)
147147
- There have a non-algorithm-based approach to achieve it (yet)
148148
- People will always find a way to connect with each other

0 commit comments

Comments
 (0)