# yotsuba

[![Build Status](https://travis-ci.org/sotojuan/yotsuba.svg?branch=master)](https://travis-ci.org/sotojuan/yotsuba)

> Elixir 4chan API client

![](https://i.imgur.com/GWohE7M.jpg)

## Install

In your `mix.exs`:

```elixir
defp deps do
  [
    {:yotsuba, "~> 1.0.0"}
  ]
end
```

Then run `mix deps.get`.

## Usage

More documentation available in [HexDocs](https://hexdocs.pm/yotsuba).

[Read the 4chan API documentation](https://github.com/4chan/4chan-API) for information on endpoints and response content.

The 4chan API provides endpoints for two resources: boards and threads. As such, there is a module for each of these.

### `Yotsuba.Board`

Interfaces with the board enpoint. The following methods are provided:

* **`Board.all/1`**
* **`Board.catalog/1`**
* **`Board.threads/1`**
* **`Board.archive/1`**
* **`Board.page_threads/2`**

### `Yotsuba.Thread`

Interfaces with the thread enpoint. The following method is provided:

* **`Thread.get/2`**

## License

MIT © [Juan Soto](https://juansoto.me)