Skip to content

Commit

Permalink
Formatting.
Browse files Browse the repository at this point in the history
  • Loading branch information
hijonathan committed Jun 10, 2020
1 parent f31f030 commit 3c7b49a
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ Simple Node.js module for accessing [Princeton University's WordNet](http://word

Check out the [examples folder](examples) for more.


# API

### `wordnet.init([database_dir])`

Loads the WordNet database. Takes an optional folder path (as a `String`).
Expand All @@ -38,14 +41,16 @@ Loads the WordNet database. Takes an optional folder path (as a `String`).

Returns definitions (metadata and glossary) for the given word. The definitions include pointers to related words, which can be omitted by passing `skipPointers = true`.

### wordnet.list()
### `wordnet.list()`

Lists all available words in the WordNet database. If called before `wordnet.init()` finishes, it will return an empty array.


# License

MIT License


# 3rd-party License

[Princeton University's WordNet License](http://wordnet.princeton.edu/wordnet/license/)

0 comments on commit 3c7b49a

Please sign in to comment.