Packages

A simple Hacker News API client in Elixir.

Current section

Files

Jump to
hn_ex README.md
Raw

README.md

# HN
A simple Hacker News API client in Elixir.
See https://github.com/HackerNews/API for a thorough description of the API and the fields returned from the various calls.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `hn_ex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:hn_ex, "~> 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/hn_ex](https://hexdocs.pm/hn_ex).