diff --git a/.npmignore b/.npmignore index 8a87533..2dafeb1 100644 --- a/.npmignore +++ b/.npmignore @@ -1,4 +1,4 @@ node_modules .project .idea -*.iml \ No newline at end of file +*.iml diff --git a/.travis.yml b/.travis.yml index 0a5ead6..2642232 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,7 @@ language: node_js node_js: + - '12' + - '11' - '10' - '8' - '6' - - '4' diff --git a/README.md b/README.md index 7591265..d6f033f 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,14 @@ Version 1.x is a major update with no direct dependence on [natural's](https://g :zap: v2.x can work in browsers -- see below for example. +## Installation + + npm install -g wordpos + +To run test: (or just: npm test) + + npm install -g mocha + mocha test ## Quick usage @@ -35,7 +43,7 @@ Command-line: (see [CLI](bin) for full command list) ```bash $ wordpos def git git - n: a person who is deemed to be despicable or contemptible; "only a rotter would do that"; "kill the rat"; "throw the bum out"; "you cowardly little pukes!"; "the British call a contemptible person a `git'" + n: a person who is deemed to be despicable or contemptible; "only a rotter would do that"; "kill the rat"; "throw the bum out"; "you cowardly little pukes!"; "the British call a contemptible person a 'git'" $ wordpos def git | wordpos get --adj # Adjective 6: @@ -47,16 +55,8 @@ little British ``` -## Installation - npm install -g wordpos - -To run test: (or just: npm test) - - npm install -g mocha - mocha test - -### Options +## Options ```js WordPOS.defaults = { @@ -298,7 +298,7 @@ Note that callback receives full arguments (including profile, if enabled), whil v2.0 introduces the capability of running wordpos in the browser. The dictionary files are optimized for fast access (lookup by lemma), but they must be fetched, parsed and loaded into browser memory. The files are loaded on-demand (unless the option `preload: true` is given). -The dict files can be served locally or from CDN (coming soon). Include the following scripts in your `index.html`: +The dict files can be served locally or from CDN (see [samples/cdn](samples/cdn/).). Include the following scripts in your `index.html`: ```html