Merge pull request #176 from pow-auth/add-assent-module-doc

Add Assent module doc
pow-auth · Dec 29, 2024 · a798fb1 · a798fb1
2 parents c4cadb1 + a477942
commit a798fb1
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.2.12 (TBA)
+
+* `Assent` now has a module doc
+
 ## v0.2.11 (2024-12-29)
 
 * Default to using `JSON` instead of `Jason` for JSON parsing on Elixir 1.18

diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@
 [![hexdocs.pm](https://img.shields.io/badge/api-docs-green.svg?style=flat)](https://hexdocs.pm/assent)
 [![hex.pm](https://img.shields.io/hexpm/v/assent.svg?style=flat)](https://hex.pm/packages/assent)
 
+<!-- MDOC !-->
+
 Multi-provider authentication framework.
 
 ## Features
@@ -37,6 +39,8 @@ Multi-provider authentication framework.
   * VK - `Assent.Strategy.VK`
   * Zitadel - `Assent.Strategy.Zitadel`
 
+<!-- MDOC !-->
+
 ## Installation
 
 Add Assent to your list of dependencies in `mix.exs`:

diff --git a/lib/assent.ex b/lib/assent.ex
@@ -1,5 +1,9 @@
 defmodule Assent do
-  @moduledoc false
+  @external_resource "README.md"
+  @moduledoc "README.md"
+             |> File.read!()
+             |> String.split("<!-- MDOC !-->")
+             |> Enum.fetch!(1)
 
   defmodule MissingConfigError do
     defexception [:key, :config]