Skip to content

Commit

Permalink
format docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zemuldo committed Oct 24, 2023
1 parent 0b5993f commit 586b6dc
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 15 deletions.
17 changes: 6 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -62,7 +57,7 @@ You can configure:

Azure KeyVault configuration:

```
```elixir
config :ex_secrets, :providers, %{
azure_key_vault: %{
tenant_id: "tenant-id",
Expand All @@ -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",
Expand All @@ -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"
Expand All @@ -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: %{
Expand All @@ -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"}
}
Expand Down
4 changes: 0 additions & 4 deletions lib/ex_secrets.ex
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 586b6dc

Please sign in to comment.