Skip to content

Commit d2f667e

Browse files
authored
Merge pull request #4 from robmckinnon/readme-release
Add install steps and docs link to readme
2 parents 5286228 + 0105406 commit d2f667e

File tree

2 files changed

+21
-5
lines changed

2 files changed

+21
-5
lines changed

README.md

+20-4
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,26 @@ Create Elixir structs from data.
55
[![Build Status](https://api.travis-ci.org/robmckinnon/data_morph.svg)](https://travis-ci.org/robmckinnon/data_morph)
66
[![Inline docs](http://inch-ci.org/github/robmckinnon/data_morph.svg)](http://inch-ci.org/github/robmckinnon/data_morph)
77

8+
## Documentation
9+
10+
You can view [full DataMorph API documentation on hexdocs](https://hexdocs.pm/data_morph/DataMorph.html).
11+
12+
## Installation
13+
14+
Add
15+
```elixir
16+
{:data_morph, "~> 0.0.1"}
17+
```
18+
to your deps in `mix.exs` like so:
19+
20+
```elixir
21+
defp deps do
22+
[
23+
{:data_morph, "~> 0.0.1"}
24+
]
25+
end
26+
```
27+
828
## Usage examples
929

1030
Define a struct and return stream of structs created from a `tsv` string, a `namespace` atom and `name` string.
@@ -56,7 +76,3 @@ iex> "name\tiso\n" <>
5676
%OpenRegister.Country{acronym: "UK", iso: nil, name: "United Kingdom"}
5777
]
5878
```
59-
60-
## Installation
61-
62-
Not on Hex yet.

mix.exs

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ defmodule DataMorph.Mixfile do
3838

3939
defp description do
4040
"""
41-
Create Elixir structs from data
41+
Create Elixir structs from data.
4242
"""
4343
end
4444

0 commit comments

Comments
 (0)