Skip to content

Commit

Permalink
Adds installation instructions to readme (#216)
Browse files Browse the repository at this point in the history
closes #215
  • Loading branch information
ryanlabouve authored and doomspork committed Dec 20, 2019
1 parent 00162f4 commit 577447d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,20 @@ of the JSON:API spec.

## How to use with Phoenix

### Installation

Add the following line to your `mix.deps` file with the desired verison to install `jsonapi`.

```elixir
defp deps do [
...
{:jsonapi, "~> x.x.x"}
...
]
```

### Usage

Simply add `use JSONAPI.View` either to the top of your view, or to the web.ex view section and add the
proper functions to your view like so.

Expand Down

0 comments on commit 577447d

Please sign in to comment.