Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Explained outputFormat options in readme.

  • Loading branch information...
commit 618993081aef195ce98a0e825705e745d3510b58 1 parent 81fff80
@mcantelon authored
Showing with 7 additions and 2 deletions.
  1. +7 −2 README.md
View
9 README.md
@@ -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 ##
Please sign in to comment.
Something went wrong with that request. Please try again.