From a477942fb0d58c72e281e374a839a8b695aabf86 Mon Sep 17 00:00:00 2001
From: Dan Schultzer <1254724+danschultzer@users.noreply.github.com>
Date: Sun, 29 Dec 2024 14:11:41 -0800
Subject: [PATCH] Add Assent module doc

---
 CHANGELOG.md  | 4 ++++
 README.md     | 4 ++++
 lib/assent.ex | 6 +++++-
 3 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index e1c24eb..d9a891d 100644
--- 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
index 4cec62b..51ad077 100644
--- 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
index 4c7c948..8814038 100644
--- 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]