isprofanity - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

		{
		"name": "isprofanity",
		"version": "1.0.0",
		"version": "1.0.1",
		"description": "A profanity checker which, unlike alternatives, uses the Wagner–Fischer algorithm in order to catch variations that you haven't thought of. ",
		@@ -5,0 +5,0 @@ "main": "isProfanity.js",

README.md

		# isProfanity
		A profanity checker which, unlike alternatives, uses the Wagner–Fischer algorithm in order to catch variations that you haven't thought of.

		[![npm](https://img.shields.io/npm/v/isprofanity.svg?style=flat-square)](https://www.npmjs.com/package/isprofanity)
		[![npm](https://img.shields.io/npm/dt/isprofanity.svg?style=flat-square)](https://www.npmjs.com/package/isprofanity)

		## Installation
		Installation is very simple due to isProfanity being on NPM. Simply type: `npm install isprofanity` from a console in the project directory then add ` var isprofanity = require('isprofanity');` to the top of your project file.

		##Usage
		There is only one function in isProfanity. Calling it is a simple as typing:
		```javascript
		isProfanity(s,function(t){
		// t will equal true if it contains a swear word and false if not
		});
		```
		's' being the string that you want to check for profanity and 't' being the boolian callback.

		For a full example usage, you can try out the following code, setting 's' as a string that you would like to test.
		```javascript
		var s = "You absolute vanker";//misspelling of 'wanker' which would be allowed by most filters...

		isProfanity(s ,function(t){
		b = t ? 'contains' : 'does not contain';
		console.log('"'+s+'" '+b+' profanity');
		process.exit();
		});
		```

		##Advance Usage
		isProfanity also contains the abilty to pass custom csv files for both profanity and exceptions. You can do this like so:
		```javascript
		isProfanity(s,function(t){
		// t will equal true if it contains a swear word and false if not
		},'data/profanity.csv','data/exceptions.csv');
		```
		While an exceptions file is not needed to replace the profanity list, it is recomended as some words to get flagged that are not swear words. (A notable example in the default set is 'while')

		---

		[![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](https://github.com/vandie/OcuCount/blob/master/LICENSE)

		---

		Follow me on twitter ([@MVD_Vandie](https://twitter.com/MVD_Vandie)) or on github in order to keep track of my projects and releases.

		[![Twitter Follow](https://img.shields.io/twitter/follow/mvd_vandie.svg?label=Follow%20on%20Twitter&style=flat-square)](https://twitter.com/MVD_Vandie)
		[![GitHub followers](https://img.shields.io/github/followers/vandie.svg?label=Follow%20on%20Github&style=flat-square)](https://github.com/vandie)

		Enjoy. :D

isprofanity - npm Package Compare versions

Improved metrics