Skip to content

Commit 5b49a27

Browse files
committed
Improved configuration documentation
1 parent a008401 commit 5b49a27

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

+13-3
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,19 @@ mod-stanford-corenlp
66

77
## Configuration
88

9-
The module takes, as usual, a JSON object for configuration. The values specified are passed directly to the
10-
[StanfordCoreNLP]() configuration as the annotator options. As a minimum a comma separated list of annotators
11-
is required under the `annotators` property
9+
The module takes a JSON object for configuration.
10+
11+
```
12+
{
13+
"address": <address>,
14+
"annotators": <annotator list>
15+
}
16+
```
17+
where the parameters are
18+
19+
* `address`: The main address for the module. Every module has a main address. Defaults to `jonnywray.corenlp`
20+
* `annotators`: List of annotators in the format expected by the StanfordCoreNLP object. Is required but no default specified
21+
* any number of other parameters that are passed directly to the StanfordCoreNLP configuration as the annotator options.
1222

1323
## Operations
1424

0 commit comments

Comments
 (0)