Permalink
Browse files

some info

  • Loading branch information...
1 parent 01d98ca commit e0c8cc5a0274b102ebfb35f43f9e247d725598f6 @jedp committed Apr 20, 2011
Showing with 20 additions and 0 deletions.
  1. +20 −0 README.md
View
20 README.md
@@ -0,0 +1,20 @@
+porter.js
+=========
+
+[Martin Porter's stemmer](http://tartarus.org/~martin/PorterStemmer/) wrapped
+in CommonJS for use in node.js.
+
+Includes a `nodeunit` test case to verify that the sample input vocabulary
+Porter provides is stemmed to the expected output.
+
+This is merely a wrapping of the javascript port done by "Andargor" with
+subsequent revisions by Christopher McKenzie. More information is available on
+Porter's site via the link given above.
+
+Example
+-------
+
+ > var stemmer = require('./porter').stemmer
+ > stemmer('Smurftastic')
+ 'Smurftast'
+

0 comments on commit e0c8cc5

Please sign in to comment.