Add README to docs

fabriziosestito · Jun 29, 2022 · d7c8093 · d7c8093
1 parent a2d693d
commit d7c8093
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/lib/commanded/event_store/spear.ex b/lib/commanded/event_store/spear.ex
@@ -3,7 +3,7 @@ defmodule Commanded.EventStore.Adapters.Spear do
   Adapter to use [Event Store](https://eventstore.com/), via the Spear library
   client, with Commanded.
 
-  Please check the [Getting started](getting-started.html) guide to learn more.
+  Please check the [Getting started](readme.html#getting-started) guide to learn more.
   """
 
   @behaviour Commanded.EventStore.Adapter

diff --git a/mix.exs b/mix.exs
@@ -51,7 +51,7 @@ defmodule Commanded.EventStore.Adapters.Spear.Mixfile do
 
   defp description do
     """
-    EventStoreDB adapter for Commanded based on Spear
+    EventStoreDB adapter for Commanded, based on Spear
     """
   end
 
@@ -61,7 +61,8 @@ defmodule Commanded.EventStore.Adapters.Spear.Mixfile do
       canonical: "http://hexdocs.pm/commanded_spear_adapter",
       source_ref: "v#{@version}",
       extras: [
-        "CHANGELOG.md"
+        "CHANGELOG.md",
+        "README.md": [filename: "readme", title: "README"]
       ]
     ]
   end