Skip to content

Commit

Permalink
Edit README
Browse files Browse the repository at this point in the history
  • Loading branch information
xurde committed Dec 4, 2015
1 parent df7fa4c commit 8f72772
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# NDC Elixir SDK

This is an Elixir package that wrapps any NDC-compliant API.
It's host-agnostic and quite flexible-through-configuration so that it can reach NDC hosts with a certain flexibility.

**TODO: Add description**

## Installation

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

1. Add ndc_ex_sdk to your list of dependencies in `mix.exs`:

def deps do
[{:ndc_ex_sdk, "~> 0.0.1"}]
end

2. Ensure ndc_ex_sdk is started before your application:

def application do
[applications: [:ndc_ex_sdk]]
end

0 comments on commit 8f72772

Please sign in to comment.