chore: setup README.md

README.md

@@ -1,21 +1,36 @@
-# Aura
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/camatcode/aura/refs/heads/main/assets/aura-logo-dark.png">
+    <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/camatcode/aura/refs/heads/main/assets/aura-logo-light.png">
+    <img alt="aura logo" src="https://raw.githubusercontent.com/camatcode/aura/refs/heads/main/assets/aura-logo-light.png" width="320">
+  </picture>
+</p>
 
-**TODO: Add description**
+<p align="center" id="top">
+  Search hex packages globally
+</p>
 
-## Installation
+<p align="center">
+  <a href="https://hex.pm/packages/aura">
+    <img alt="Hex Version" src="https://img.shields.io/hexpm/v/aura.svg">
+  </a>
+  <a href="https://hexdocs.pm/aura">
+    <img alt="Hex Docs" src="http://img.shields.io/badge/hex.pm-docs-green.svg?style=flat">
+  </a>
+  <a href="https://opensource.org/licenses/Apache-2.0">
+    <img alt="Apache 2 License" src="https://img.shields.io/hexpm/l/aura">
+  </a>
+  <a href="https://github.com/camatcode/aura/actions?query=branch%3Amain++">
+    <img alt="ci status" src="https://github.com/camatcode/aura/workflows/ci/badge.svg">
+  </a>
+  <a href='https://coveralls.io/github/camatcode/aura?branch=main'>
+    <img src='https://coveralls.io/repos/github/camatcode/aura/badge.svg?branch=main' alt='Coverage Status' />
+  </a>
+  <a href="https://mastodon.social/@scrum_log" target="_blank" rel="noopener noreferrer">
+    <img alt="Mastodon Follow" src="https://img.shields.io/badge/mastodon-%40scrum__log%40mastodon.social-purple?color=6364ff">
+  </a>
+</p>
 
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `aura` to your list of dependencies in `mix.exs`:
-
-```elixir
-def deps do
-  [
-    {:aura, "~> 0.1.0"}
-  ]
-end
-```
-
-Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
-and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
-be found at <https://hexdocs.pm/aura>.
+## Table of Contents
 
+- [Installation](#installation)

mix.exs

@@ -1,10 +1,13 @@
-defmodule Aura.MixProject do
+defmodule ExFTP.MixProject do
   use Mix.Project
 
+  @source_url "https://github.com/camatcode/aura"
+  @version "0.9.0"
+
   def project do
     [
       app: :aura,
-      version: "0.1.0",
+      version: @version,
       elixir: "~> 1.18",
       start_permanent: Mix.env() == :prod,
       deps: deps(),
@@ -15,16 +18,61 @@ defmodule Aura.MixProject do
         "coveralls.post": :test,
         "coveralls.html": :test,
         "coveralls.cobertura": :test
+      ],
+      # Hex
+      package: package(),
+      description: """
+      Easy, global hex package search via the hex API
+      """,
+
+      # Docs
+      name: "Aura",
+      docs: [
+        main: "Aura",
+        api_reference: false,
+        logo: "assets/aura-logo.png",
+        source_ref: "v#{@version}",
+        source_url: @source_url,
+        extra_section: "GUIDES",
+        formatters: ["html"],
+        extras: extras(),
+        groups_for_modules: groups_for_modules(),
+        skip_undefined_reference_warnings_on: ["CHANGELOG.md"]
       ]
     ]
   end
 
+  defp groups_for_modules do
+    []
+  end
+
+  def package do
+    [
+      maintainers: ["Cam Cook"],
+      licenses: ["Apache-2.0"],
+      files: ~w(lib .formatter.exs mix.exs README* CHANGELOG* LICENSE*),
+      links: %{
+        Website: @source_url,
+        Changelog: "#{@source_url}/blob/master/CHANGELOG.md",
+        GitHub: @source_url
+      }
+    ]
+  end
+
+  def extras do
+    [
+      "README.md"
+    ]
+  end
+
+  # Run "mix help compile.app" to learn about applications.
   def application do
     [
       extra_applications: [:logger]
     ]
   end
 
+  # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
       {:ex_doc, "~> 0.37", only: :dev, runtime: false},
@@ -34,6 +82,7 @@ defmodule Aura.MixProject do
       {:excoveralls, "~> 0.18", only: [:test]},
       {:ex_machina, "~> 2.8.0", only: :test},
       {:faker, "~> 0.18.0", only: :test},
+      {:junit_formatter, "~> 3.1", only: [:test]},
       {:req, "~> 0.5.10"}
     ]
   end

mix.lock

@@ -11,6 +11,7 @@
   "finch": {:hex, :finch, "0.19.0", "c644641491ea854fc5c1bbaef36bfc764e3f08e7185e1f084e35e0672241b76d", [:mix], [{:mime, "~> 1.0 or ~> 2.0", [hex: :mime, repo: "hexpm", optional: false]}, {:mint, "~> 1.6.2 or ~> 1.7", [hex: :mint, repo: "hexpm", optional: false]}, {:nimble_options, "~> 0.4 or ~> 1.0", [hex: :nimble_options, repo: "hexpm", optional: false]}, {:nimble_pool, "~> 1.1", [hex: :nimble_pool, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}], "hexpm", "fc5324ce209125d1e2fa0fcd2634601c52a787aff1cd33ee833664a5af4ea2b6"},
   "hpax": {:hex, :hpax, "1.0.3", "ed67ef51ad4df91e75cc6a1494f851850c0bd98ebc0be6e81b026e765ee535aa", [:mix], [], "hexpm", "8eab6e1cfa8d5918c2ce4ba43588e894af35dbd8e91e6e55c817bca5847df34a"},
   "jason": {:hex, :jason, "1.4.4", "b9226785a9aa77b6857ca22832cffa5d5011a667207eb2a0ad56adb5db443b8a", [:mix], [{:decimal, "~> 1.0 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: true]}], "hexpm", "c5eb0cab91f094599f94d55bc63409236a8ec69a21a67814529e8d5f6cc90b3b"},
+  "junit_formatter": {:hex, :junit_formatter, "3.4.0", "d0e8db6c34dab6d3c4154c3b46b21540db1109ae709d6cf99ba7e7a2ce4b1ac2", [:mix], [], "hexpm", "bb36e2ae83f1ced6ab931c4ce51dd3dbef1ef61bb4932412e173b0cfa259dacd"},
   "makeup": {:hex, :makeup, "1.2.1", "e90ac1c65589ef354378def3ba19d401e739ee7ee06fb47f94c687016e3713d1", [:mix], [{:nimble_parsec, "~> 1.4", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "d36484867b0bae0fea568d10131197a4c2e47056a6fbe84922bf6ba71c8d17ce"},
   "makeup_elixir": {:hex, :makeup_elixir, "1.0.1", "e928a4f984e795e41e3abd27bfc09f51db16ab8ba1aebdba2b3a575437efafc2", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}, {:nimble_parsec, "~> 1.2.3 or ~> 1.3", [hex: :nimble_parsec, repo: "hexpm", optional: false]}], "hexpm", "7284900d412a3e5cfd97fdaed4f5ed389b8f2b4cb49efc0eb3bd10e2febf9507"},
   "makeup_erlang": {:hex, :makeup_erlang, "1.0.2", "03e1804074b3aa64d5fad7aa64601ed0fb395337b982d9bcf04029d68d51b6a7", [:mix], [{:makeup, "~> 1.0", [hex: :makeup, repo: "hexpm", optional: false]}], "hexpm", "af33ff7ef368d5893e4a267933e7744e46ce3cf1f61e2dccf53a111ed3aa3727"},