Permalink
Browse files

Updated built-in module usage details

  • Loading branch information...
1 parent 710ac50 commit 0cb932cfa9fbb293f92da31526dae399a8f22717 @chriso chriso committed Dec 21, 2010
Showing with 8 additions and 8 deletions.
  1. +7 −7 builtin/README.md
  2. +1 −1 builtin/resolve.coffee
View
@@ -10,7 +10,7 @@ To see usage details, run
$ node.io [MODULE] help
-**digest**
+### digest
This module calculates the hash/checksum of each element of input. Available hashes are [md5, crc32, sha1, sha256, sha512, ...]
@@ -19,7 +19,7 @@ Example 1 - find the MD5 hash of a string
$ echo "this is a string" | node.io digest md5
=> b37e16c620c055cf8207b999e3270e9b
-**pagerank**
+### pagerank
This module checks a URL's Google pagerank (rate limits apply)
@@ -28,7 +28,7 @@ Example 1 - find the pagerank of mastercard.com
$ echo "mastercard.com" | node.io pagerank
=> mastercard.com,7
-**resolve**
+### resolve
This module provides DNS resolution utilities
@@ -48,7 +48,7 @@ Example 4 - return unique IPs
$ node.io resolve ips < domains.txt
-**validate**
+### validate
This module is a simple wrapper for [node-validator](https://github.com/chriso/node-validator). Available filters are: [int, url, ip, alpha, alphanumeric, email]
@@ -60,7 +60,7 @@ Example 2 - output lines that do not match a filter (remove valid lines)
$ node.io validate not [FILTER] < list.txt
-**eval**
+### eval
This module evaluates an expression on each line of input and emits the result (unless the result is null)
@@ -72,13 +72,13 @@ Example 2 - convert a TSV (tab separated file) to CSV
$ node.io -s eval "input.split('\t').join(',')" < data.tsv > data.csv
-**word_count**
+### word_count
This module uses map/reduce to count word occurrences in a file
$ node.io word_count < input.txt
-**duplicates**
+### duplicates
This module can find or remove duplicates from a list
@@ -1,5 +1,5 @@
usage = '''
-This module provides DNS resolution jobs
+This module provides DNS resolution utilities
1. To resolve domains and return "domain,ip":
$ node.io resolve < domains.txt

0 comments on commit 0cb932c

Please sign in to comment.