Permalink
Browse files

Improved configuration documentation

  • Loading branch information...
1 parent a008401 commit 5b49a27b9433c6b440669ed037029858431298cc @jonnywray committed Dec 22, 2013
Showing with 13 additions and 3 deletions.
  1. +13 −3 README.md
View
@@ -6,9 +6,19 @@ mod-stanford-corenlp
## Configuration
-The module takes, as usual, a JSON object for configuration. The values specified are passed directly to the
-[StanfordCoreNLP]() configuration as the annotator options. As a minimum a comma separated list of annotators
-is required under the `annotators` property
+The module takes a JSON object for configuration.
+
+```
+{
+ "address": <address>,
+ "annotators": <annotator list>
+}
+```
+ where the parameters are
+
+ * `address`: The main address for the module. Every module has a main address. Defaults to `jonnywray.corenlp`
+ * `annotators`: List of annotators in the format expected by the StanfordCoreNLP object. Is required but no default specified
+ * any number of other parameters that are passed directly to the StanfordCoreNLP configuration as the annotator options.
## Operations

0 comments on commit 5b49a27

Please sign in to comment.