Skip to content

Commit

Permalink
Merge pull request #26 from jfacorro/jfacorro.25.fix_readme
Browse files Browse the repository at this point in the history
[Closes #25] Fix README add application deps
  • Loading branch information
jfacorro committed Jun 13, 2015
2 parents c85a71b + 223365a commit c5e08e2
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 4 deletions.
4 changes: 3 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,6 @@ otp_release:
- 17.1
- 17.3
- 17.4
sudo: false # to use faster container based build environment
sudo: false # to use faster container based build environment
notifications:
email: false
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,13 @@ def deps do
end
```

Since Eden is not an OTP application there is no need to add it to the list of `:applications` in your `mix.exs`.
Eden is a library application and as such doesn't specify an application callback module. Even so, if you would like to build a release that includes Eden, you need to add it as an application depedency in your `mix.exs`:

```elixir
def application do
[applications: [:eden]]
end
```

## Examples

Expand All @@ -41,7 +47,7 @@ iex> Eden.decode("[1 2 3 4]")
{:ok, #Array<[1, 2, 3, 4], fixed=false, default=nil>}

iex> Eden.decode("nil true false")
{:ok, #Array<[1, 2, 3, 4], fixed=false, default=nil>}
{:ok, [nil, true, false]}

iex> Eden.decode("nil true false .")
{:error, Eden.Exception.UnexpectedInputError}
Expand Down
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ defmodule Eden.Mixfile do
end

def application do
[applications: [:logger]]
[applications: [:timex, :array]]
end

defp deps do
Expand Down

0 comments on commit c5e08e2

Please sign in to comment.