https://github.com/lechindianer/ex_pnut

ExPnut is an Elixir wrapper for the pnut API.
https://github.com/lechindianer/ex_pnut

elixir pnut

Last synced: 4 days ago
JSON representation

ExPnut is an Elixir wrapper for the pnut API.

• Host: GitHub
• URL: https://github.com/lechindianer/ex_pnut
• Owner: Lechindianer
• License: isc
• Created: 2019-07-11T21:41:37.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2019-08-04T20:22:23.000Z (over 5 years ago)
• Last Synced: 2024-10-28T22:38:49.181Z (19 days ago)
• Topics: elixir, pnut
• Language: Elixir
• Homepage: https://hex.pm/packages/ex_pnut
• Size: 55.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ExPnut

ExPnut is an Elixir wrapper for the pnut API.

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed

by adding `ex_pnut` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:ex_pnut, "~> 0.1.0"}

  ]

end

```

## Usage

Create `config/dev.exs` with the following content:

```elixir

use Mix.Config

config :ex_pnut,

  user_token:

    "YOUR_USER_TOKEN"

```

The first step is to create a client:

```elixir

client = Application.get_env(:ex_pnut, :user_token)

  |> ExPnut.Client.new()

```

To receive your posts:

```elixir

ExPnut.Posts.Streams.me(client)

```

## Documentation

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/ex_pnut](https://hexdocs.pm/ex_pnut).