Contents

# NameTamer

[![Gem Version](https://badge.fury.io/rb/name-tamer.png)](http://badge.fury.io/rb/name-tamer)
![build status](https://circleci.com/gh/Xenapto/name-tamer.png?circle-token=2293f2a1d8463a948c2a2ce4bb3bd99786958c59)
[![Coverage Status](https://img.shields.io/coveralls/Xenapto/name-tamer.svg)](https://coveralls.io/r/Xenapto/name-tamer)

NameTamer: making sense of names

## Installation

Add this line to your application's Gemfile:

    gem 'name-tamer'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install name-tamer

## Usage

Examples:

```ruby
NameTamer['Mr. John Q. Smith III, MD'].simple_name # => John Smith
```

```ruby
name_tamer = NameTamer['Mr. John Q. Smith III, MD']
name_tamer.slug # => john-smith
name_tamer.nice_name # => John Q. Smith
```

## Contributing

1.  Fork it
1.  Create your feature branch (`git checkout -b my-new-feature`)
1.  Commit your changes (`git commit -am 'Add some feature'`)
1.  Push to the branch (`git push origin my-new-feature`)
1.  Create new Pull Request

## Acknowledgements

1.  Thanks to Ryan Bigg for the guide to making your first gem https://github.com/radar/guides/blob/master/gem-development.md

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
name-tamer-0.0.2	README.md
name-tamer-0.0.1	README.md