Skip to content

imzeeshan/Knwl.js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Knwl.js

Find dates, times, emails, phone numbers, links, reading time, even the emotion of the text, or check if it's spam. Knwl.js makes it possible to scan through large amounts of text for data that may be of interest.

####Cenny.js Plugin For those interested in version of Knwl.js that has basic Cenny.js functionality (early development), look here: https://github.com/loadfive/cenny.js/tree/master/plugins

###Demo: http://byteaspect.com/knwlDemo

##How to use

Add Knwl.js to the <head>

Create a new instance of the Knwl object:

var x = new Knwl();

Initiate crawling of a string:

x.init( string );

Get data:

x.get('dates'); //returns array of dates found: [month,day,year, string snippet]

Types of data that can grabbed:

"dates" - dates found in string.

"times" - times found in string.

"links" - links found in string.

"emails" - emails found in string.

"phones" - phone numbers found in string.

"readingTime" - estimated reading time of string.

"emotion" - estimated emotion, works best with shorter strings (comments, etc).

"spam" - checks if text is possibly spam. Returns true or false.

Please note that Knwl.js is still in early development, and can yield varying results.

If you want a real-time, plug 'n play backend to store all the data you find, you might like Cenny.js: http://github.com/loadfive/cenny.js

###Building

For Node, if uglify-js is installed globally ( npm install uglify-js -g ) then

uglifyjs -o ./knwl.min.js ./knwl.js

will create knwl.min.js.

###Licence

Project released under an MIT license.

About

Scan through text for data that may be of interest.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published