From f520c1ac042f7c8140f49fe8e84404efa66941aa Mon Sep 17 00:00:00 2001
From: Zach Daniel <zach@zachdaniel.dev>
Date: Fri, 3 May 2024 20:53:32 -0400
Subject: [PATCH] docs: documentation overhaul

---
 README.md                                     | 31 +++++++++----------
 ... getting-started-with-ash-double-entry.md} |  6 ++++
 mix.exs                                       |  5 +--
 3 files changed, 24 insertions(+), 18 deletions(-)
 rename documentation/tutorials/{get-started-with-double-entry.md => getting-started-with-ash-double-entry.md} (98%)

diff --git a/README.md b/README.md
index 155b572..afd05b9 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,21 @@
+![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_double_entry/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_double_entry.svg)](https://hex.pm/packages/ash_double_entry)
+[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/ash_double_entry)
+
 # AshDoubleEntry
 
-An extensible double entry system built using [Ash](ash-hq.org) resources.
+Welcome! This is the extension for building a double entry accounting system in [Ash](https://hexdocs.pm/ash). This extension provides the basic building blocks for you to extend as necessary.
 
-See the [getting started guide](https://hexdocs.pm/ash_double_entry/get-started-with-double-entry.html) to
-setup the project!
+## Tutorials
 
-## Installation
+- [Getting Started with AshDoubleEntry](documentation/tutorials/getting-started-with-ash-double-entry.md)
 
-The package can be installed by adding `ash_double_entry` to your list of dependencies in `mix.exs`:
+## Reference
 
-```elixir
-def deps do
-  [
-    {:ash_double_entry, "~> 1.0.0-rc.1"}
-  ]
-end
-```
-
-# Upgrading from 0.1 to 0.2
-
-This is a breaking change, that changes from using a currency & decimal amount to using `ash_money`. There is no way to configure it to use the old behavior, as maintaining both is not reasonable.
\ No newline at end of file
+- [AshDoubleEntry.Account DSL](documentation/dsls/DSL:-AshDoubleEntry.Account.md)
+- [AshDoubleEntry.Transfer DSL](documentation/dsls/DSL:-AshDoubleEntry.Transfer.md)
+- [AshDoubleEntry.Balance DSL](documentation/dsls/DSL:-AshDoubleEntry.Balance.md)
diff --git a/documentation/tutorials/get-started-with-double-entry.md b/documentation/tutorials/getting-started-with-ash-double-entry.md
similarity index 98%
rename from documentation/tutorials/get-started-with-double-entry.md
rename to documentation/tutorials/getting-started-with-ash-double-entry.md
index 34b2b7b..7561efe 100644
--- a/documentation/tutorials/get-started-with-double-entry.md
+++ b/documentation/tutorials/getting-started-with-ash-double-entry.md
@@ -14,6 +14,12 @@ Ash Double Entry is implemented as a set of Ash resource extensions. You build t
 
 Follow the setup guide for `AshMoney`. If you are using with `AshPostgres`, be sure to include the `:ex_money_sql` dependency in your `mix.exs`.
 
+### Add the dependency
+
+```elixir
+{:ash_double_entry, "~> 1.0.0-rc.0"}
+```
+
 ### Define your account resource
 
 #### Example
diff --git a/mix.exs b/mix.exs
index 1a6796f..889f679 100644
--- a/mix.exs
+++ b/mix.exs
@@ -64,7 +64,7 @@ defmodule AshDoubleEntry.MixProject do
 
   defp docs do
     [
-      main: "get-started-with-double-entry",
+      main: "readme",
       source_ref: "v#{@version}",
       logo: "logos/small-logo.png",
       before_closing_head_tag: fn type ->
@@ -83,7 +83,8 @@ defmodule AshDoubleEntry.MixProject do
         end
       end,
       extras: [
-        "documentation/tutorials/get-started-with-double-entry.md",
+        {"README.md", title: "Home"},
+        "documentation/tutorials/getting-started-with-ash-double-entry.md",
         "documentation/dsls/DSL:-AshDoubleEntry.Account.md",
         "documentation/dsls/DSL:-AshDoubleEntry.Balance.md",
         "documentation/dsls/DSL:-AshDoubleEntry.Transfer.md"