# wordsworth

[![Build Status](https://travis-ci.org/booyaa/wordsworth.svg?branch=master)](https://travis-ci.org/booyaa/wordsworth)

A collection of useful natural language functions.

Full documentation can be found [here](https://booyaa.github.io/wordsworth/wordsworth/index.html).


# Usage
This crate is [on crates.io](https://crates.io/crates/wordsworth) and can be
used by adding `wordsworth` to the dependencies in your project's `Cargo.toml`.

```toml
[dependencies]
wordsworth = "0.1.*"
```

and this to your crate root:

```rust
extern crate wordsworth;
```
# Example

```rust
use wordsworth;
assert_eq!(3, syllable_counter("lucozade"));
assert_eq!(false, is_haiku("this is not\nnot\n a haiku"));
```