README.md

# NFLPlayerSearchex

search for nfl players via the official search

## To Do
* `v0.3.0`
  * Add documentation
  * Publish to Hex
* `v0.3.1`
  * Add `P` & `K` position statistics
* `v0.3.2`
  * Add `by_team`
  * Add atom support for `position`
  * Add atom support for `team`
* `v0.3.1`
  * Add `historical` boolean option as keyword list options
  * Add `conference` atom option as keyword list options for `by_position`
  * Add Credo styling
* `v0.4.0`
  * Add `Player` struct
  * Add `@spec` documentation

## Installation

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

```elixir
def deps do
  [{:nfl_player_searchex, "~> 0.2.0"}]
end
```

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/nfl_player_searchex](https://hexdocs.pm/nfl_player_searchex).