use tar.gz DB file and unpack at install. Bump version to 3.0.1

README.md

@@ -43,18 +43,19 @@ The purpose of this package is to allow a convenient way to download WordNet fil
 Installation
 ------------
 
-    npm install WNdb -g (coming)
+    npm install WNdb
 
-or, in the meantime, use an __http__ path in your package.json dependencies:
+or, use a git url in your package.json dependencies:
 
 ```
   ...
   "dependencies": {
-    "WNdb": "http://github.com/moos/WNdb/tarball/master"
+    "WNdb": "git://github.com/moos/WNdb.git"
   },
   ...
 ```
-__NOTE__: do not use the git path "git://github.com/moos/WNdb.git" as this will mess up CRLF (if git config core.autocrlf is true) of the WordNet data files.
+
+Package is about __10 MB__ in size and uncompresses to about 34 MB.
 
 Properties
 ------------
@@ -66,6 +67,16 @@ WNdb.files (array) -- list of file names under the path
 WNdb.version (string) -- version string of WordNet database file
 
 
+Changes
+---------
+
+v3.0.x are pegged to WordNet 3.0 DB.
+
+v3.0.0 -- includes the uncompressed (text) dict files.  On Windows systems, do a `git config core.autocrlf false` before cloning so that CRLF isn't applied to data files.
+
+v3.0.1 -- this includes the actual WordNet tar file, which is unpacked at install time.  There should be no CRLF issues.  Uses build-in 'zlib' package, therefore requires node > 0.6.
+
+
 License
 -------