Skip to content

Commit

Permalink
Explained outputFormat options in readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
mcantelon committed Dec 31, 2010
1 parent 81fff80 commit 6189930
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,13 @@ 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).
By default, node-calais will return fetched results as a Javascript object.
Alternatively, the Calais standard "outputFormat" input parameter can be set to
standard output formats (see Calais documentation).

Any standard Calais input parameter can be passed as an option, as well as the
'cleanResult' parameter which will return a simplified Javascript object if
"outputFormat" hasn't been set to something other than the default ('object').

## Test ##

Expand Down

0 comments on commit 6189930

Please sign in to comment.