Browse files

Added explanation of cleanResult to README.

  • Loading branch information...
1 parent bc01533 commit 1e90bce2ea0b1db24f4393a7f47568f702476188 @mcantelon committed Dec 30, 2010
Showing with 10 additions and 0 deletions.
  1. +10 −0 README
View
10 README
@@ -17,6 +17,16 @@ Usage:
Example:
# node example.js
+Options:
+
+In addition to using the "set" method, a hash of option settings can be passed
+as the second argument when constructing. For example:
+
+ var calais = new Calais('<YOUR API KEY>', {'cleanResult': false})
+
+Any Calais input parameter can be passed, as well as the 'cleanResult' parameter
+(which can be set to false to show the raw Calais result).
+
Test:
# expresso test/calais.test.js

0 comments on commit 1e90bce

Please sign in to comment.