Merge pull request #84 from beamkenya/badges

Added Badges and missing module doc

.gitignore

@@ -24,4 +24,5 @@ at_ex-*.tar
 .elixir_ls/
 
 /config/dev.exs
-/.vscode
+/.vscode
+config/prod.exs

README.md

@@ -1,4 +1,6 @@
-[badges][badges] [badges]
+<p align="left"><img src="assets/logo.jpg" width="170"></p>
+
+[![Actions Status](https://github.com/beamkenya/africastalking-elixir/workflows/Elixir%20CI/badge.svg)](https://github.com/beamkenya/africastalking-elixir/actions) &nbsp;  ![Hex.pm](https://img.shields.io/hexpm/v/at_ex) &nbsp; ![Hex.pm](https://img.shields.io/hexpm/dt/at_ex)
 
 # AtEx
 

lib/at_ex.ex

@@ -1,25 +1,6 @@
 defmodule AtEx do
   @moduledoc """
   AtEx is an Elixir Wrapper for the Africas Talking Api
-
-  Use this library to handle interaction with the Africas Talking API end points,
-  It is most useful for
-  - Consuming incoming events that have been parsed
-  - Building valid responses
-
-  This is in development, currently the following parts of the API are working:
-  - SMS (Non Premium Sms)
-  - USSD
-  - Airtime
-  - Application
-
-  ## Getting Started
-  Configuration
-    config :at_ex,
-      api_key: "YOURAPIKEY",
-      content_type: "application/x-www-form-urlencoded",
-      accept: "application/json",
-      username: "YOURUSERNAME"
   """
   alias AtEx.Gateway.{
     Airtime,

lib/at_ex/gateway/Sms/premium.ex

@@ -1,4 +1,8 @@
 defmodule AtEx.Gateway.Sms.PremiumSubscriptions do
+  @moduledoc """
+  This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking API Premium SMS endpoint, complete a premium sms create subscription request, incrementally fetch your premium sms subscriptions, delete a premium sms subscription
+  """
+
   import AtEx.Util
 
   @live_url "https://api.africastalking.com/version1"

lib/at_ex/gateway/Voice/make_call.ex

@@ -1,4 +1,8 @@
 defmodule AtEx.Gateway.Voice.MakeCall do
+  @moduledoc """
+  This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Voice API endpoints to make an outbound call 
+  """
+
   import AtEx.Util
 
   @live_url "https://voice.africastalking.com"

lib/at_ex/gateway/Voice/queue_status.ex

@@ -1,4 +1,8 @@
 defmodule AtEx.Gateway.Voice.QueueStatus do
+  @moduledoc """
+  This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Voice API endpoint to queueing calls
+  """
+
   import AtEx.Util
 
   @live_url "https://voice.africastalking.com"

lib/at_ex/gateway/Voice/upload_media.ex

@@ -1,4 +1,8 @@
 defmodule AtEx.Gateway.Voice.UploadMedia do
+  @moduledoc """
+  This module holds the implementation for the HTTP Gateway that runs calls against the Africas Talking Voice API endpoint tfor uploading media file
+  """
+
   import AtEx.Util
 
   @live_url "https://voice.africastalking.com"

mix.exs

@@ -11,7 +11,16 @@ defmodule AtEx.MixProject do
       description: description(),
       package: package(),
       name: "AtEx",
-      source_url: "https://github.com/elixirkenya/africastalking-elixir"
+      source_url: "https://github.com/elixirkenya/africastalking-elixir",
+      docs: [
+        # The main page in the docs
+        main: "readme",
+        canonical: "http://hexdocs.pm/at_ex",
+        source_url: "https://github.com/beamkenya/africastalking-elixir",
+        logo: "assets/logo.jpg",
+        assets: "assets",
+        extras: ["README.md"]
+      ]
     ]
   end