Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
zemuldo committed Nov 9, 2023
1 parent f1f3cb5 commit c91c39f
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
6 changes: 3 additions & 3 deletions lib/ex_secrets.ex
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ defmodule ExSecrets do
@doc """
Get secret value.
You can pass two options:
- provider: Name of the provider to use. Default is :system_env
- default_value: Default value to return if secret is not found. Default is nil
- provider: Name of the provider to use. Default is :system_env
- default_value: Default value to return if secret is not found. Default is nil
## Examples
Expand Down Expand Up @@ -109,7 +109,7 @@ defmodule ExSecrets do
@doc """
Get secret value with provider name and default value
"""
@deprecated "This function is deprecated. Use get/2 instead."
@deprecated "Use get/2 instead."
def get(key, provider, default) do
case get(key, provider: provider) do
nil -> default
Expand Down
19 changes: 12 additions & 7 deletions mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,14 @@ defmodule ExSecrets.MixProject do
def project do
[
app: :ex_secrets,
version: "0.3.1",
version: "0.3.2",
elixir: "~> 1.13",
build_embedded: Mix.env() == :prod,
start_permanent: Mix.env() == :prod,
description: description(),
package: package(),
deps: deps(),
docs: [
# The main page in the docs
main: "readme",
logo: "logo.png",
extras: ["README.md", "GUIDES.md", "CHANGELOG.md", "LICENSE"]
]
docs: docs()
]
end

Expand Down Expand Up @@ -63,4 +58,14 @@ defmodule ExSecrets.MixProject do
links: %{"GitHub" => "https://github.com/zemuldo/ex_secrets"}
]
end

defp docs() do
[
source_url: "https://github.com/zemuldo/ex_secrets",
source_ref: "main",
main: "readme",
logo: "logo.png",
extras: ["README.md", "GUIDES.md", "CHANGELOG.md", "LICENSE"]
]
end
end

0 comments on commit c91c39f

Please sign in to comment.