README.md

# HumanName

Elixir bindings for the [human-name](https://crates.io/crates/human_name) crate implemented as a safe Rust NIF.

## Installation

_Be sure to [install Rust](https://www.rust-lang.org/tools/install)._

This package can be installed by adding `human_name` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:human_name, "~> 0.1.0"}
  ]
end
```

## Usage

```elixir
iex> HumanName.first_name("Dr. Alibaster Cornelius Juniper III")
{:ok, "Alibaster"}

iex> HumanName.initials("Dr. Alibaster Cornelius Juniper III")
{:ok, "AJ"}

iex> HumanName.last_name("Dr. Alibaster Cornelius Juniper III")
{:ok, "Juniper"}

iex> HumanName.normalize("Dr. Alibaster Cornelius Juniper III")
{:ok, "Alibaster Juniper"}

iex> HumanName.normalize_full("JIMMY H JENKINS")
{:ok, "Jimmy H. Jenkins"}
```

----

## License

MIT License

See the [license file](LICENSE.txt) for details.