Skip to content

Commit

Permalink
updates docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zemuldo committed Nov 15, 2023
1 parent 547fdf7 commit 6e66eb3
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,22 @@ def deps do
end
```

## Basic Usage
## How it works

This library loads secrets on demand from APIs or files. For dotenv file, it is loaded at startup and saved in the cache.
Secrets are encrypted when store in the cache with a master key generated at startup. Enables developers to access keys securely.

Key features include:

- FETCH and SET secrets.
- Key fetch throttling.
- Authentications with providers like Azure Keyvault and Google Secrets manager and token renewals.
- Catching of secrets.
- Default key options.
- You can configure multiple secrets and access from different providers.
- RESET and RELOAD secrets without shutting down your application.

## Usage

### Get a secret

Expand Down Expand Up @@ -46,7 +61,7 @@ nil
iex(7)>
```

### Se Secret
### Set Secret

You can set a new secret version using:

Expand All @@ -55,6 +70,15 @@ iex(20)> ExSecrets.set("TEST", "test", provider: :azure_key_vault)
:ok
```

### Reset and Reload

To reset the secrets and reload, this will clear the cached values and reload doenv. For other providers, values will be fetched on demand.

```elixir
iex(20)> ExSecrets.reset()
:ok
```

## Supported Providers

You can configure:
Expand Down

0 comments on commit 6e66eb3

Please sign in to comment.