README.md

# HackerNewsClient
Elixir Wrapper for HackerNews API
See https://github.com/HackerNews/API for more information.

#### Functions
```elixir
HackerNewsClient.ask_stories()
# Returns up to 100 ask stories

HackerNewsClient.best_stories()
# Returns up to 100 of the best stories

HackerNewsClient.job_stories()
# Returns up to 100 job stories

HackerNewsClient.new_stories()
# Returns up to 100 new stories

HackerNewsClient.show_stories()
# Returns up to 100 show stories

HackerNewsClient.top_stories()
# Returns up to 100 of the top stories
```

## Installation

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

```elixir
def deps do
  [
    {:hacker_news_client, "~> 0.1.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/hacker_news_client](https://hexdocs.pm/hacker_news_client).