better readme

mdirolf · Sep 23, 2008 · 90828ba · 90828ba
1 parent 6f181c9
commit 90828ba
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README b/README
@@ -1,3 +1,14 @@
 pyporter2: A python implementation of the Porter2 stemmer.
 
 See http://snowball.tartarus.org/algorithms/english/stemmer.html
+
+USAGE
+-----
+>>> import porter2
+>>> porter2.stem('stemming')
+'stem'
+
+UNIT TESTS
+----------
+To run the unit tests do:
+> python porter2.py