From 4752d7e53364bc78974079de8986c3e157acc66d Mon Sep 17 00:00:00 2001
From: Zach Daniel <zach@zachdaniel.dev>
Date: Fri, 3 May 2024 16:04:15 -0400
Subject: [PATCH] docs: docs overhaul

---
 README.md                                      | 18 +++++++++++++++++-
 ...ey.md => getting-started-with-ash-money.md} |  0
 mix.exs                                        | 11 ++++-------
 3 files changed, 21 insertions(+), 8 deletions(-)
 rename documentation/tutorials/{get-started-with-ash-money.md => getting-started-with-ash-money.md} (100%)

diff --git a/README.md b/README.md
index dfa66f9..119a639 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,19 @@
+![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-black-text.png?raw=true#gh-light-mode-only)
+![Logo](https://github.com/ash-project/ash/blob/main/logos/cropped-for-header-white-text.png?raw=true#gh-dark-mode-only)
+
+![Elixir CI](https://github.com/ash-project/ash_money/workflows/CI/badge.svg)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Hex version badge](https://img.shields.io/hexpm/v/ash_money.svg)](https://hex.pm/packages/ash_money)
+[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/ash_money)
+
 # AshMoney
 
-A money extension for Ash.
+Welcome! This is the extension for working with money types in [Ash](https://hexdocs.pm/ash). This is a thin wrapper around the very excellent [ex_money](https://hexdocs.pm/ex_money). It provides:
+
+- An `Ash.Type` for representing `Money`
+- An `AshPostgres.Extension` for supporting common money operations directly in the database
+- An implementation of `Comp` for `%Money{}`, allowing Ash to compare them.
+
+## Tutorials
+
+- [Getting Started with AshMoney](documentation/tutorials/getting-started-with-ash-money.md)
diff --git a/documentation/tutorials/get-started-with-ash-money.md b/documentation/tutorials/getting-started-with-ash-money.md
similarity index 100%
rename from documentation/tutorials/get-started-with-ash-money.md
rename to documentation/tutorials/getting-started-with-ash-money.md
diff --git a/mix.exs b/mix.exs
index 138b10f..47ce1fe 100644
--- a/mix.exs
+++ b/mix.exs
@@ -4,7 +4,7 @@ defmodule AshMoney.MixProject do
   @version "0.1.6-rc.1"
 
   @description """
-  A money extension for Ash.
+  The extension for working with money types in Ash.
   """
 
   def project do
@@ -18,10 +18,6 @@ defmodule AshMoney.MixProject do
       package: package(),
       elixirc_paths: elixirc_paths(Mix.env()),
       dialyzer: [plt_add_apps: [:ash]],
-      preferred_cli_env: [
-        coveralls: :test,
-        "coveralls.github": :test
-      ],
       docs: docs(),
       description: @description,
       source_url: "https://github.com/ash-project/ash_money",
@@ -58,7 +54,7 @@ defmodule AshMoney.MixProject do
 
   defp docs do
     [
-      main: "get-started-with-ash-money",
+      main: "readme",
       source_ref: "v#{@version}",
       logo: "logos/small-logo.png",
       extra_section: "GUIDES",
@@ -78,7 +74,8 @@ defmodule AshMoney.MixProject do
         end
       end,
       extras: [
-        "documentation/tutorials/get-started-with-ash-money.md"
+        {"README.md", title: "Home"},
+        "documentation/tutorials/getting-started-with-ash-money.md"
       ],
       groups_for_extras: [
         Tutorials: ~r'documentation/tutorials',