From 586b6dc441dc181ac401bee06f9dcd02546cc734 Mon Sep 17 00:00:00 2001
From: Zemuldo <danstan.otieno@gmail.com>
Date: Tue, 24 Oct 2023 13:35:32 +0300
Subject: [PATCH] format docs

---
 README.md         | 17 ++++++-----------
 lib/ex_secrets.ex |  4 ----
 2 files changed, 6 insertions(+), 15 deletions(-)

diff --git a/README.md b/README.md
index 46d657f..a7ba0bc 100644
--- a/README.md
+++ b/README.md
@@ -4,8 +4,7 @@ App config secret manager for different providers.
 
 ## Installation
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `ex_secrets` to your list of dependencies in `mix.exs`:
+Install by adding `ex_secrets` to your list of dependencies in `mix.exs`:
 
 ```elixir
 def deps do
@@ -15,10 +14,6 @@ def deps do
 end
 ```
 
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at <https://hexdocs.pm/ex_secrets>.
-
 ## Basic Usage
 
 Secrets are first fetched using system environment. If found thats the value that is used. For this, no configuration is required.
@@ -62,7 +57,7 @@ You can configure:
 
 Azure KeyVault configuration:
 
-```
+```elixir
   config :ex_secrets, :providers, %{
     azure_key_vault: %{
       tenant_id: "tenant-id",
@@ -75,7 +70,7 @@ Azure KeyVault configuration:
 
 Using certificate. You can use `client_certificate_path` or `client_certificate_string`. See Azure keyvault provider section for more details
 
-```
+```elixir
   config :ex_secrets, :providers, %{
     azure_key_vault: %{
       tenant_id: "tenant-id",
@@ -90,7 +85,7 @@ Using certificate. You can use `client_certificate_path` or `client_certificate_
 
   Azure Managed Identity Configuration:
 
-  ```
+  ```elixir
   config :ex_secrets, :providers, %{
     azure_managed_identity: %{
       key_vault_name: "key-vault-name"
@@ -102,7 +97,7 @@ Using certificate. You can use `client_certificate_path` or `client_certificate_
 
   Using service account. You can use `service_account_credentials` or `service_account_credentials_path`. See Azure keyvault provider section for more details
 
-```
+```elixir
   config :ex_secrets, :providers, %{
     google_secret_manager: %{
       service_account_credentials: %{
@@ -125,7 +120,7 @@ Using certificate. You can use `client_certificate_path` or `client_certificate_
 
   Dotenv file:
 
-  ```
+  ```elixir
   config :ex_secrets, :providers, %{
     dot_env: %{path: "/path/.env"}
   }
diff --git a/lib/ex_secrets.ex b/lib/ex_secrets.ex
index 2b1eed7..fa17ceb 100644
--- a/lib/ex_secrets.ex
+++ b/lib/ex_secrets.ex
@@ -1,10 +1,6 @@
 defmodule ExSecrets do
   @moduledoc """
   This module functions to access secrets in an Elixir application.
-
-  Configuration is available for all secret providers:
-
-  Provider specific configurations.
   """
 
   alias ExSecrets.Cache