docs: Rewrite docs for consistent format with other Ash packages (#18)

README.md

@@ -1,36 +1,15 @@
-# AshAppsignal
-
-A drop in Ash.Tracer implementation for Appsignal. Follow the appsignal setup
-before setting this up.
-
-## Setup
+![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)
 
-Add the dependency to your application
+[![CI](https://github.com/ash-project/ash_appsignal/actions/workflows/elixir.yml/badge.svg)](https://github.com/ash-project/ash_appsignal/actions/workflows/elixir.yml)
+[![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_appsignal.svg)](https://hex.pm/packages/ash_appsignal)
+[![Hexdocs badge](https://img.shields.io/badge/docs-hexdocs-purple)](https://hexdocs.pm/ash_appsignal)
 
-```elixir
-def deps do
-  [
-    {:ash_appsignal, "~> 0.1.2"}
-  ]
-end
-```
-
-Add this to your config:
-
-```elixir
-# config supports a list, so this can be combined with other tracers
-config :ash, :tracer, [AshAppsignal]
+# AshAppsignal
 
-# Optionally configure span types to be sent to appsignal. The default is
-# [:custom, :action, :flow]
-config :ash_appsignal,
-  trace_types: [
-    :custom,
-    :action,
-    :flow
-  ]
-```
+Welcome! `AshAppsignal` is an integration between [Ash Framework](https://hexdocs.pm/ash) and the [AppSignal APM](https://www.appsignal.com).
 
-For all available types see the documentation for `Ash.Tracer`
+## Tutorials
 
-Thats it! Additional traces & spans from Ash will be displayed in appsignal.
+- [Get Started with AshAppsignal](documentation/tutorials/getting-started-with-ash-appsignal.md)

documentation/tutorials/getting-started-with-ash-appsignal.md

@@ -0,0 +1,47 @@
+# Getting Started with AshAppsignal
+
+## Installation
+
+Add `ash_appsignal` to your list of dependencies in `mix.exs`:
+
+
+```elixir
+def deps do
+  [
+    {:ash_appsignal, "~> 0.1.2"}
+  ]
+end
+```
+
+## Configuration
+
+After installing the `ash_appsignal` dependency, add this to your config:
+
+```elixir
+# `config` supports a list, so this can be combined with other tracers
+config :ash, :tracer, [AshAppsignal]
+
+# Optionally configure span types to be sent to appsignal. The default is
+# [:custom, :action, :flow]
+# We suggest using this list. It trims down some noisy traces that Ash emits
+config :ash_appsignal,
+  trace_types: [
+    :custom,
+    :action,
+    :changeset,
+    :validation,
+    :change,
+    :before_transaction,
+    :before_action,
+    :after_transaction,
+    :after_action,
+    :custom_flow_step,
+    :flow,
+    :query,
+    :preparation
+  ]
+```
+
+For all available types, see the documentation for `Ash.Tracer`.
+
+Thats it! Additional traces and spans from Ash will now be displayed in AppSignal.

mix.exs

@@ -2,7 +2,7 @@ defmodule AshAppsignal.MixProject do
   use Mix.Project
 
   @description """
-  A drop in Ash.Tracer implementation for Appsignal.
+  The AppSignal APM integration for Ash Framework
   """
 
   @version "0.1.2"
@@ -34,7 +34,7 @@ defmodule AshAppsignal.MixProject do
       logo: "logos/small-logo.png",
       extra_section: "GUIDES",
       extras: [
-        "documentation/tutorials/trace-with-appsignal.md"
+        "documentation/tutorials/getting-started-with-ash-appsignal.md"
       ],
       groups_for_extras: [
         Tutorials: ~r'documentation/tutorials',