docs

zemuldo · Oct 23, 2023 · 1d88d49 · 1d88d49
1 parent 5e86d14
commit 1d88d49
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 3 deletions.
diff --git a/GUIDES.md b/GUIDES.md
diff --git a/README.md b/README.md
@@ -2,8 +2,6 @@
 
 App config secret manager for different providers.
 
-
-
 ## Installation
 
 If [available in Hex](https://hex.pm/docs/publish), the package can be installed
@@ -21,3 +19,19 @@ Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_do
 and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
 be found at <https://hexdocs.pm/ex_secrets>.
 
+## Basic Usage
+
+## Supported Providers
+
+
+## Provider Config
+
+
+## HTTP Client Config
+
+
+## JSON Parser Config
+
+
+## Configuration
+
diff --git a/lib/application.ex b/lib/application.ex
@@ -1,4 +1,9 @@
 defmodule ExSecrets.Application do
+
+  @moduledoc """
+  Application for adding providers and cache to the supervision tree.
+  All are besically GenServers that do a bunch of API calls and file access like .env reader
+  """
   use Application
 
   alias ExSecrets.Providers.SystemEnv

diff --git a/logo.png b/logo.png
diff --git a/mix.exs b/mix.exs
@@ -10,7 +10,12 @@ defmodule ExSecrets.MixProject do
       start_permanent: Mix.env() == :prod,
       description: description(),
       package: package(),
-      deps: deps()
+      deps: deps(),
+      docs: [
+      main: "readme", # The main page in the docs
+      logo: "logo.png",
+      extras: ["README.md", "GUIDES.md", "CHANGELOG.md", "LICENSE"]
+    ]
     ]
   end
 
@@ -44,6 +49,8 @@ defmodule ExSecrets.MixProject do
   defp package() do
     [
       name: "ex_secrets",
+      source_url: "https://github.com/zemuldo/ex_secrets",
+      homepage_url: "https://hexdocs.pm/ex_secrets/readme.html",
       files: ~w(lib .formatter.exs mix.exs README* LICENSE* CHANGELOG*),
       licenses: ["Apache-2.0"],
       links: %{"GitHub" => "https://github.com/zemuldo/ex_secrets"}