-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |