defmodule Yotsuba do
  @moduledoc """
  Client for the 4chan API.

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

  ## Usage

  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`**
  """
end