From a70b727d092cb88d261c4df234244cb2e66fce3e Mon Sep 17 00:00:00 2001 From: kamalogudah Date: Sun, 9 Aug 2020 23:51:51 +0300 Subject: [PATCH] Release 0.20.20 finalization --- README.md | 27 +++++++++++++++++++++++---- mix.exs | 7 +++++-- 2 files changed, 28 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bfaca66..1df2a98 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Here are the main modules we hope to develop in the process. - [x] USSD - [x] Airtime - [x] Payments -- [ ] IoT +- [x] IoT - [x] Application ## Installation @@ -33,19 +33,38 @@ Available in Hex, the package can be installed by adding `at_ex` to your list of ```elixir def deps do [ - {:at_ex, "~> 0.20.19"} + {:at_ex, "~> 0.20.20"} ] end ``` ## Configuration -- Create a `dev.exs` file under the `config` folder in the root of the project. like `touch config/dev.exs`. +- Create a `dev.exs` file under the `config` folder in the root of the project if you do not have it. like `touch config/dev.exs` to setup configs for development environment i.e, sandbox credentials check sample configuration below. +- Create a `prod.exs` file under the `config` folder in the root of the project if you dont have it. like `touch config/prod.exs` to setup `at_ex` configs for production environment i.e, live credentials check sample configuration below. - Copy the contents of `dev.sample.exs` into the `dev.exs` created above. - Go to [Africas Talking](https://account.africastalking.com/auth/register) to register for an account. -- On signing up go to the `https://account.africastalking.com/apps/sandbox`ntop get an **api key** +- On signing up go to the `https://account.africastalking.com/apps/sandbox` to get an **api key** - Add the **api key** in the `api_key:`value in the `config/dev.exs` created above. +## Example Configuration setup +``` elixir +config :at_ex, + api_key: "===INSERT AFRICAS_TALKING_API_KEY HERE ===", + content_type: "application/x-www-form-urlencoded", + accept: "application/json", + username: "sandbox", #change to live username for prod.ex + stk_product_name: "AtEx", #Add your specific product name. + b2c_product_name: "AtEx", + b2b_product_name: "AtEx", + bank_checkout_product_name: "AtEx", + bank_transfer_product_name: "AtEx", + card_checkout_product_name: "AtEx", + # When changed to "YES" one will use the live endpoint url when in development + force_live_url: "NO" +``` + + ## Documentation The docs can be found at [https://hexdocs.pm/at_ex](https://hexdocs.pm/at_ex). diff --git a/mix.exs b/mix.exs index 31f23a4..df09faa 100644 --- a/mix.exs +++ b/mix.exs @@ -4,7 +4,7 @@ defmodule AtEx.MixProject do def project do [ app: :at_ex, - version: "0.20.19", + version: "0.20.20", elixir: "~> 1.8", start_permanent: Mix.env() == :prod, deps: deps(), @@ -40,8 +40,11 @@ defmodule AtEx.MixProject do [ # This option is only needed when you don't want to use the OTP application name name: "at_ex", + maintainers: ["Paul Oguda", "Magak Emmanuel", "Zacck Osiemo", "Tracey Onim", "Sigu Magwa"], licenses: ["MIT"], - links: %{"GitHub" => "https://github.com/elixirkenya/africastalking-elixir"} + links: %{"GitHub" => "https://github.com/elixirkenya/africastalking-elixir"}, + source_url: "https://github.com/elixirkenya/africastalking-elixir", + homepage_url: "https://github.com/elixirkenya/africastalking-elixir" ] end end