README.md

Profane-Js

A small and lighweight offline profanity checker

Getting Started

  npm i profane-js --save

Prerequisites

Node Package Manager Installed

  var profanity = require('profane-js');
  profanity.containsProfanity(String);

Example

  profanity.containsProfanity('good'); //return false
  profanity.containsProfanity('ass'); //return true
  profanity.containsProfanity('hey bitch'); //return true

Built With

• javascript

Authors

• Anuj Singh - Initial work - anujsinghwd

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Contribution

Feel free to contribute

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration