Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Converted readme to Markdown.

  • Loading branch information...
commit 07365dff17a6aa511ff2f09897ef91387cdba324 1 parent 1e90bce
Mike Cantelon authored
Showing with 17 additions and 12 deletions.
  1. +17 −12 README
29 README
View
@@ -1,33 +1,38 @@
-node-calais
------------
+# node-calais #
node-calais allows semantic analysis of text using the Calais web service.
+## Install ##
+
Install using npm:
# npm install calais
-Usage:
+## Usage ##
+
+ var calais = new Calais('<YOUR API KEY>')
+ calais.set('content', 'The Federal Reserve is the enemy of Ron Paul.')
+ calais.fetch(function(result) {
+ // do something with result
+ })
- var calais = new Calais('<YOUR API KEY>')
- calais.set('content', 'The Federal Reserve is the enemy of Ron Paul.')
- calais.fetch(function(result) {
- // do something with result
- })
+## Example ##
-Example:
+Run quick example:
# node example.js
-Options:
+## 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})
+ 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:
+** Test **
+
+Run tests:
# expresso test/calais.test.js
Tested with node.js v0.3.0
Please sign in to comment.
Something went wrong with that request. Please try again.