tkn - npm Package Compare versions

Comparing version 0.0.3 to 0.0.4

lib/tkn.js

@@ -25,6 +25,6 @@ var stopwords = require('stopwords').english; /* Dependency. List of english stop words. */
 		noStopWords = (typeof noStopWords === 'undefined') ? true : noStopWords;  // set default to `true`
-		text = text.match(regex); // breaking text word-by-word
+		text = text.toLowerCase().match(regex); // breaking text word-by-word
 		if (noStopWords) text = text.filter(isStopWord); // removing stopwords
 		return text;
 	}	
-}
+}

package.json

 {
   "name": "tkn",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Simple word tokeniser that ignores punctuation.",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -5,1 +5,14 @@ tkn
 Simple word tokeniser that ignores punctuation. Returning an `Array` of words.
+
+### Usage
+`tokenise(text, noStopWords)`. Simply returns an array of terms, without punctuation.
+
+* `text` is the string (text document) in which the calculations are to be performed on.
+* `noStopWords` defaults to `true`. Set to `false` if you want to include stop words–e.g words such as "I" and "the".
+
+```javascript
+var tkn = require('tkn');
+
+var str = "you're simply a test, a mere test";
+var tokenised = tkn.tokenise(str);
+>> ['simply', 'test', 'mere', 'test']

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3503

increased by16.03%

Lines of code

66

increased by1.54%

Number of lines in readme file

18

increased by260%

No dependency changes