README.md
# Cognixir
**Elixir API Wrapper for [Cognitive Services](https://www.microsoft.com/cognitive-services/en-us/apis) from Microsoft**
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed as:
1. Add `Cognixir` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:Cognixir, "~> 0.1.0"}]
end
```
2. Ensure `Cognixir` is started before your application:
```elixir
def application do
[applications: [:Cognixir]]
end
```
## Configuration
You need a subscription key to access the different cognitive service api. Head over to https://www.microsoft.com/cognitive-service, create an account and fetch your api key. You can get started with a free subscription.
Add to your config.exs:
```elixir
# api key for text analytics
config :Cognixir, ta_api_key: "<your key>"
```