Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 883 Bytes

README.md

File metadata and controls

48 lines (33 loc) · 883 Bytes

ExPnut

ExPnut is an Elixir wrapper for the pnut API.

Installation

If available in Hex, the package can be installed by adding ex_pnut to your list of dependencies in mix.exs:

def deps do
  [
    {:ex_pnut, "~> 0.1.0"}
  ]
end

Usage

Create config/dev.exs with the following content:

use Mix.Config

config :ex_pnut,
  user_token:
    "YOUR_USER_TOKEN"

The first step is to create a client:

client = Application.get_env(:ex_pnut, :user_token)
  |> ExPnut.Client.new()

To receive your posts:

ExPnut.Posts.Streams.me(client)

Documentation

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/ex_pnut.