From 5f7a72cf445d0e6cfb6e3317b8b0f5f810e93579 Mon Sep 17 00:00:00 2001
From: moos <mooster@42at.com>
Date: Mon, 7 May 2012 00:39:57 -0700
Subject: [PATCH] updated readme

---
 .npmignore |  2 ++
 README.md  | 22 +++++++++-------------
 2 files changed, 11 insertions(+), 13 deletions(-)
 create mode 100644 .npmignore

diff --git a/.npmignore b/.npmignore
new file mode 100644
index 0000000..6e829d9
--- /dev/null
+++ b/.npmignore
@@ -0,0 +1,2 @@
+node_modules
+.project
diff --git a/README.md b/README.md
index 5f91d34..15f43ee 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@ Usage
 -------
 
 ```js
-var WordPOS = require('./wordpos'),
+var WordPOS = require('wordpos'),
     wordpos = new WordPOS();
 
 wordpos.getAdjectives('The angry bear chased the frightened little squirrel.', function(result){
@@ -28,21 +28,15 @@ See `wordpos_spec.js` for full usage.
 Installation
 ------------
 
-Get the script `wordpos.js` and use it.  (npm package may be coming.)
-
-or use a git path in your package.json dependencies:
-```
-  ...
-  "dependencies": {
-    "wordpos": "git://github.com/moos/wordpos.git"
-  },
-  ...
-```
-
-As of version 0.1.1, WordNet DB files are obtained off-line through dependency provided by [WNdb](https://github.com/moos/WNdb) module.
+     npm install wordpos
 
 Note: `wordpos-bench.js` requires a [forked uubench](https://github.com/moos/uubench) module.
 
+To run spec:
+
+    npm install jasmine-node -g
+    jasmine-node wordpos_spec.js --verbose
+
 
 API
 -------
@@ -190,6 +184,8 @@ wordpos.lookup('great', console.log);
 Benchmark
 ----------
 
+    node wordpos-bench.js
+
 Generally slow as it requires loading and searching large WordNet index files.
 
 Single word lookup: