updated README.
This commit is contained in:
parent
40411b7f3a
commit
6ef8c8ce5b
29
README.md
29
README.md
|
@ -1,21 +1,10 @@
|
||||||
wordpos
|
wordpos
|
||||||
=======
|
=======
|
||||||
|
|
||||||
wordpos is a set of part-of-speech utilities for Node.js using [natural's](http://github.com/NaturalNode/natural) WordNet module.
|
wordpos is a set of part-of-speech utilities for Node.js using [natural's] http://github.com/NaturalNode/natural) WordNet module.
|
||||||
|
|
||||||
There is no lexigraphical intelligence here. Only dictionary lookup.
|
There is no lexigraphical intelligence here. Only dictionary lookup.
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
|
|
||||||
Get the script `wordpos.js` and use it. (npm module may be coming.)
|
|
||||||
|
|
||||||
You may also want to manually download WordNet files from [here](http://wordnet.princeton.edu/wordnet/download/current-version/).
|
|
||||||
Unpack into folder (say `dict`, see below). [natrual](http://github.com/NaturalNode/natural) will auto-download WordNet files --
|
|
||||||
but I've found this to be unreliable as some of the files get truncated and the core program hangs.
|
|
||||||
|
|
||||||
Note: `wordpos-bench` requires a customized [uubench](https://github.com/moos/uubench) module (forthcoming).
|
|
||||||
|
|
||||||
Usage
|
Usage
|
||||||
-------
|
-------
|
||||||
|
|
||||||
|
@ -36,13 +25,23 @@ Usage
|
||||||
|
|
||||||
See `wordpos_spec.js` for full usage.
|
See `wordpos_spec.js` for full usage.
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
Get the script `wordpos.js` and use it. (npm module may be coming.)
|
||||||
|
|
||||||
|
You may also want to manually download WordNet files from [here](http://wordnet.princeton.edu/wordnet/download/current-version/). Unpack into folder (say `dict`, see below). [natrual](http://github.com/NaturalNode/natural) will auto-download WordNet files --
|
||||||
|
but I've found this to be unreliable as some of the files get truncated and the core program hangs.
|
||||||
|
|
||||||
|
Note: `wordpos-bench` requires a customized [uubench](https://github.com/moos/uubench) module (forthcoming).
|
||||||
|
|
||||||
|
|
||||||
API
|
API
|
||||||
-------
|
-------
|
||||||
|
|
||||||
Please note: all API are async since the underlying WordNet library is async.
|
Please note: all API are async since the underlying WordNet library is async.
|
||||||
|
|
||||||
WordPOS is a subclass of natural's [WordNet](https://github.com/NaturalNode/natural#wordnet) class
|
WordPOS is a subclass of natural's [WordNet class](https://github.com/NaturalNode/natural#wordnet) and inherits call its methods.
|
||||||
and inherits call it's methods.
|
|
||||||
|
|
||||||
|
|
||||||
### getX()
|
### getX()
|
||||||
|
@ -155,8 +154,10 @@ In this case only one lookup was found. But there could be several.
|
||||||
|
|
||||||
Or use WordNet's inherited method directly:
|
Or use WordNet's inherited method directly:
|
||||||
|
|
||||||
|
```js
|
||||||
wordpos.lookup('great', console.log);
|
wordpos.lookup('great', console.log);
|
||||||
// ...
|
// ...
|
||||||
|
```
|
||||||
|
|
||||||
Benchmark
|
Benchmark
|
||||||
----------
|
----------
|
||||||
|
|
Loading…
Reference in New Issue