Skip to content

Commit

Permalink
Added docs readme and install instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
alisinabh committed Jun 17, 2017
1 parent f45eadb commit 0b5c93f
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ It can help you spend your time mostly on your issues instead of developing API

```elixir
def deps do
[{:prex, "~> 0.1.0", only: [:dev]}]
[{:prex, "~> 0.1.0", only: :dev, runtime: false}]
end
```

Expand All @@ -40,7 +40,7 @@ end
defmodule MyApi.User do
@moduledoc """
Represents user details.
**User attributes:**
- id `(Number)` : unique identifier.
- fname `(String)` : First Name.
Expand Down
5 changes: 3 additions & 2 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule Prex.Mixfile do
use Mix.Project

@version "0.0.1"
@version "0.0.2"

def project do
[app: :prex,
Expand All @@ -13,7 +13,8 @@ defmodule Prex.Mixfile do
package: package(),
deps: deps(),
name: "Prex",
source_url: "https://github.com/alisinabh/prex"]
source_url: "https://github.com/alisinabh/prex",
docs: [main: "readme", extras: ["README.md"]]]
end

# Configuration for the OTP application
Expand Down

0 comments on commit 0b5c93f

Please sign in to comment.