Context defining profane vs non-profane words

[adlawson]

I know it's not really an issue to do with the library as such, but it may be worth warning users about the potential implications if used incorrectly.

Here's two very real stories of incorrectly applied filtering:

• Northumberland County Council (or some subsidiary of) nearly lost a multi-million pound contract due to internal correspondence filtering the word "breast" from a mothering campaign
• Some websites I use (YP Railcard for example) filter their address fields, usually rendering my address as " Pond Road" instead of "Balls Pond Road"

Common sense would tell you that the profanity filters in these cases may have been incorrectly applied, and context should have been taken into account.

As far as this issue and this library are concerned, maybe accounting for context is a bit out of scope, but a small warning in the readme might be useful.

[tancredi]

Good point, will better explain the scope of this utility in the readme.

[tancredi]

Added this to the readme:

Please note: This small utility module is written to prevent or monitor the use of certain words in your content without keeping context in account. An improper use may compromise the meaning of your content. Keep in account when using.

I'm aware that this type of solution may not work for everyone, in my specific use-case (I'm building a platform that children should be able to browse as safely as possible) it's more important to prevent swearing than risking compromising the content in some instances.

Interesting facts though, wasn't aware of those cases :+1:

[adlawson]

Looks good to me :+1: :dancers: