Update README.md

master
ChimneySwift 2018-10-18 09:50:51 +10:00 committed by GitHub
parent eed3424994
commit f7e38663bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 1 deletions

View File

@ -1,2 +1,13 @@
# wordlists
# Word Lists
An extensive compilation of potentially offensive words for use in chat filters
`all.txt` contains a list of 1923 potentially offensive words and word obfuscations.
`curated.txt` contains a curated list of 455 words which would be considered offencive to most people.
Note: It's a good idea to compile a single regex and reuse it to match these words for performance reasons. It's also a good idea to use a loop to generate obfuscations if you want a more aggressive filter.
# Credit
The large word list is based off of Google's offensive word list, with some additional words and obfuscations added by me.
The curated word list is based off of the large word list