moby/README.md

An open-source website (and CLI) for searching the largest thesaurus in the English language.

# moby

[moby-thesaurus.org](http://moby-thesaurus.org) is a free and
open-source website designed to facilitate meanderings through the [Moby
Thesaurus](http://en.wikipedia.org/wiki/Moby_Project#Thesaurus), the largest
thesaurus in the English language. As of version 1.0, this package also includes
synonym data from the [Open Office thesaurus](http://goo.gl/UGBfHI).

This git repository is many things:

- The source code for the [moby-thesaurus.org](http://moby-thesaurus.org/) website.
- A tiny and simple JavaScript interface for querying Moby Thesaurus and Open Office Thesaurus data.
- A command-line interface (CLI) for searching a local, cached copy of the thesaurus from the terminal.
- A module on npm called [moby](https://www.npmjs.org/package/moby).
- Rad.

## Browser Usage

Go to [moby-thesaurus.org](http://moby-thesaurus.org/) and get lost in the associations.

## Command Line Usage

Install [node.js](http://nodejs.org/) if you don't already have it. Then:

```sh
npm install moby --global
moby ecstasy
```

Display results one per line:

```sh
moby weird | tr , '\n'
```

## Node.js Usage

Install moby in your project directory. The `--save` flags adds it to the list of
`dependencies` in your package.json file.

```sh
cd my-project
npm install moby --save
```

Then in your javascript code:

```js
var moby = require('moby')

console.log(moby.search('mad'))
console.log(moby.search('smaragdine'))
console.log(moby.reverseSearch('smaragdine'))
```

## License

Same license as the one on the [moby project homepage](http://icon.shef.ac.uk/Moby/):

The Moby lexicon project is complete and has been placed into the public domain.
Use, sell, rework, excerpt and use in any way on any platform. Placing this
material on internal or public servers is also encouraged. The compiler is not
aware of any export restrictions so freely distribute world-wide.

See also the Open Office license included in the
[thesaurus](https://github.com/daizoru/node-thesaurus/blob/5cadf8d26ea879a6009702524970ce706f04bb99/LICENSE.txt)
package.