docs(README.md): improving doc

Author: gerardobort

README.md

@@ -2,41 +2,44 @@
 
 *This project is under active development, please stay tuned for updates.  More documentation and examples are comming.*
 
+This library connects to Stanford CoreNLP either via HTTP or by spawning processes.  The first (HTTP) is the preferred method since it requires CoreNLP to initialize just once to serve many requests, it also avoids extra I/O given that the CLI method need to write temporary files to run.
 
 ## Setup
 
-This library connects to Stanford CoreNLP either via HTTP or by spawning processes.  The first (HTTP) is the preferred method since it requires CoreNLP to initialize just once to serve many requests, it also avoids extra I/O given that the CLI method need to write temporary files to run.
-
 ### 1. Install the package:
 
-```
+```bash
 npm i --save corenlp
 ```
 
-### 2. Download CoreNLP
+### 2. Download Stanford CoreNLP
 
-http://nlp.stanford.edu/software/stanford-corenlp-full-2017-06-09.zip
+Check the Stanford's project download section at: https://stanfordnlp.github.io/CoreNLP/download.html
+You may want to download, apart of the full package, other language models (see more on that page).
 
-### 3.1. Use CoreNLP as HTTP Server
 
-```
+### 3. Configure Stanford CoreNLP
+
+#### 3.1. Use CoreNLP as HTTP Server
+
+```bash
 # Run the server using all jars in the current directory (e.g., the CoreNLP home directory)
 java -mx4g -cp "*" edu.stanford.nlp.pipeline.StanfordCoreNLPServer -port 9000 -timeout 15000
 ```
 
 CoreNLP connects by default via StanfordCoreNLPServer, using port 9000.  You can also opt to setup the connection differently:
 
-```
+```javascript
 import CoreNLP from 'corenlp';
 
 CoreNLP.setup('English', new CoreNLP.connector.ConnectorServer({ dsn: 'http://localhost:9000' }));
 ```
 
-### 3.2. Use CoreNLP via CLI
+#### 3.2. Use CoreNLP via CLI
 
 CoreNLP expects by default the StanfordCoreNLP package to be placed (unzipped) inside the path `${YOUR_NPM_PROJECT_ROOT}/corenlp/`.  You can also opt to setup the CLI interface differently:
 
-```
+```javascript
 import CoreNLP from 'corenlp';
 
 CoreNLP.setup('English', new CoreNLP.connector.ConnectorCli({
@@ -47,16 +50,29 @@ CoreNLP.setup('English', new CoreNLP.connector.ConnectorCli({
 }));
 ```
 
+### 4. Use it
+
+```javascript
+// ...
+
+const sent = new CoreNLP.simple.Sentence('Hello world');
+sent.applyAnnotator(CoreNLP.simple.annotator.TokenizerAnnotator)
+  .then(() => {
+    console.log(sent.words());
+  });
+```
+
 ## Examples
 
-NOTE: The examples below assumes that StanfordCoreNLP is running on port `9000`.
+NOTE1: The examples below assumes that StanfordCoreNLP is running on port `9000`.
+NOTE2: The examples below assumes `es6` syntax, if you use require, use as follows: `var CoreNLP = require('corenlp').default;`
 
 ### English
 
 ```javascript
 import CoreNLP from 'corenlp';
 
-CoreNLP.setup('English');
+CoreNLP.setup('English'); // check method docs for more setup options
 const sent = new CoreNLP.simple.Sentence('The little dog runs so fast.');
 sent.applyAnnotator(CoreNLP.simple.annotator.ParserAnnotator)
   .then(() => {
@@ -73,7 +89,7 @@ sent.applyAnnotator(CoreNLP.simple.annotator.ParserAnnotator)
 ```javascript
 import CoreNLP from 'corenlp';
 
-CoreNLP.setup('Spanish');
+CoreNLP.setup('Spanish'); // check method docs for more setup options
 const sent = new CoreNLP.simple.Sentence('El pájaro veloz come kiwi.');
 sent.applyAnnotator(CoreNLP.simple.annotator.ParserAnnotator)
   .then(() => {
@@ -90,29 +106,29 @@ sent.applyAnnotator(CoreNLP.simple.annotator.ParserAnnotator)
 We will update this section soon.  In the meantime, you can browse the project codebase and read the @jsdoc referenecs.
 In summary, this NodeJS library aims to replicate the CoreNLP Simple Java interface but in Javascript.  There are some minor differences however, for example the need to call `applyAnnotator` asynchronously.
 
-```
+```bash
 CoreNLP
   connector
-    ConnectorServer # https://stanfordnlp.github.io/CoreNLP/corenlp-server.html
-    ConnectorCli # https://stanfordnlp.github.io/CoreNLP/cmdline.html
-  simple # https://stanfordnlp.github.io/CoreNLP/simple.html
+    ConnectorServer               # https://stanfordnlp.github.io/CoreNLP/corenlp-server.html
+    ConnectorCli                  # https://stanfordnlp.github.io/CoreNLP/cmdline.html
+  simple                          # https://stanfordnlp.github.io/CoreNLP/simple.html
     Annotable
     Annotator
     Document
     Sentence
     Token
-    annotator # https://stanfordnlp.github.io/CoreNLP/annotators.html
-      TokenizerAnnotator # https://stanfordnlp.github.io/CoreNLP/tokenize.html
-      WordsToSentenceAnnotator # https://stanfordnlp.github.io/CoreNLP/ssplit.html
-      POSTaggerAnnotator # https://stanfordnlp.github.io/CoreNLP/pos.html
-      MorphaAnnotator # https://stanfordnlp.github.io/CoreNLP/lemma.html
-      NERClassifierCombiner # https://stanfordnlp.github.io/CoreNLP/ner.html
-      ParserAnnotator # https://stanfordnlp.github.io/CoreNLP/parse.html
-      DependencyParseAnnotator # https://stanfordnlp.github.io/CoreNLP/depparse.html
-      RelationExtractorAnnotator # https://stanfordnlp.github.io/CoreNLP/relation.html
+    annotator                     # https://stanfordnlp.github.io/CoreNLP/annotators.html
+      TokenizerAnnotator          # https://stanfordnlp.github.io/CoreNLP/tokenize.html
+      WordsToSentenceAnnotator    # https://stanfordnlp.github.io/CoreNLP/ssplit.html
+      POSTaggerAnnotator          # https://stanfordnlp.github.io/CoreNLP/pos.html
+      MorphaAnnotator             # https://stanfordnlp.github.io/CoreNLP/lemma.html
+      NERClassifierCombiner       # https://stanfordnlp.github.io/CoreNLP/ner.html
+      ParserAnnotator             # https://stanfordnlp.github.io/CoreNLP/parse.html
+      DependencyParseAnnotator    # https://stanfordnlp.github.io/CoreNLP/depparse.html
+      RelationExtractorAnnotator  # https://stanfordnlp.github.io/CoreNLP/relation.html
       DeterministicCorefAnnotator # https://stanfordnlp.github.io/CoreNLP/coref.html
   util
-    Tree # http://www.cs.cornell.edu/courses/cs474/2004fa/lec1.pdf
+    Tree                          # http://www.cs.cornell.edu/courses/cs474/2004fa/lec1.pdf
 ```
 
 ## Stanford CoreNLP Reference