aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJason A. Donenfeld <Jason@zx2c4.com>2011-09-07 15:12:42 -0400
committerJason A. Donenfeld <Jason@zx2c4.com>2011-09-07 15:13:16 -0400
commit067332378d7e5614d0217d7b06a72e827abbd646 (patch)
tree8592a42dd44dfb528a28856f889aeef9ada3580f
parentAllow arbitrary target word. (diff)
downloadwiki-philosophy-067332378d7e5614d0217d7b06a72e827abbd646.tar.xz
wiki-philosophy-067332378d7e5614d0217d7b06a72e827abbd646.zip
Update readme
-rw-r--r--README.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/README.md b/README.md
index 2c0ee40..4f8c4ce 100644
--- a/README.md
+++ b/README.md
@@ -7,9 +7,18 @@ This is a simple script that takes a single input word and finds how many clicks
git clone http://git.zx2c4.com/wiki-philosophy
npm install jsdom -g
-## How to Use
+## Usage
+
+ node wiki-philosophy.js word [target]
+
+To measure _word_'s distance to "Philosophy":
+
+ node wiki-philosophy.js word
+
+You may also measure _word_'s distance to any arbitrary _target_:
+
+ node wiki-philosophy.js word target
- node wiki-philosophy.js [search]
## Example
$ node wiki-philosophy.js seinfeld