# abbrev

> Calculates the set of unambiguous abbreviations for a given set of strings.

[![CircleCI](https://img.shields.io/circleci/project/github/CraigCottingham/abbrev.svg?style=flat)](https://circleci.com/gh/CraigCottingham/abbrev)
[![Github open issues](https://img.shields.io/github/issues/CraigCottingham/abbrev.svg?style=flat)](https://github.com/CraigCottingham/abbrev/issues)
[![Github open PRs](https://img.shields.io/github/issues-pr/CraigCottingham/abbrev.svg?style=flat)](https://github.com/CraigCottingham/abbrev/pulls)
[![License](https://img.shields.io/github/license/CraigCottingham/abbrev.svg?style=flat-square)](https://github.com/CraigCottingham/abbrev/blob/master/LICENSE)

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `abbrev` to your list of dependencies in `mix.exs`:

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

Don't forget to run `mix deps.get` afterwards.

## Usage

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/abbrev](https://hexdocs.pm/abbrev).

## Contributing

  1. Clone the repository.
  2. Install dependencies with `mix deps.get`.

Pull requests are welcome. Pull requests with specs covering the changes
are especially welcome. Pull requests with specs, which have been run through
`mix format`, and pass `mix credo` are extra-especially welcome. :smile:

Unit tests were written with [ESpec](https://github.com/antonmi/espec).

## To Do

See the [open issues on Github](https://github.com/CraigCottingham/abbrev/issues).

## Acknowledgements

`abbrev` was inspired by [the Ruby gem of the same name](http://ruby-doc.org/stdlib-2.6.3/libdoc/abbrev/rdoc/Abbrev.html).

## Copyright

Copyright (c) 2019 Craig S. Cottingham, except where stated otherwise.

## License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions
and limitations under the License.