Put readme as main hex page

jsonmaur · Jan 30, 2023 · 3ff302c · 3ff302c
1 parent 24ccfc7
commit 3ff302c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Namor
 
-![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jsonmaur/namor.ex/test?label=test&style=plastic)
+![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/jsonmaur/namor.ex/test.yml?label=test&style=plastic)
 ![Hex.pm](https://img.shields.io/hexpm/v/namor?style=plastic)
 
 Namor is a name generator for Elixir that creates random, url-friendly names. This comes in handy if you need to generate unique subdomains like many PaaS/SaaS providers do, or unique names for anything else.

diff --git a/mix.exs b/mix.exs
@@ -6,21 +6,23 @@ defmodule Namor.MixProject do
   def project do
     [
       app: :namor,
+      name: "Namor",
       version: "1.0.0",
       elixir: "~> 1.13",
       deps: deps(),
       aliases: aliases(),
       start_permanent: Mix.env() == :prod,
-      description: "A subdomain-safe name generator",
       source_url: @url,
       homepage_url: "#{@url}#readme",
+      description: "A subdomain-safe name generator",
+      authors: ["Jason Maurer"],
       package: [
-        name: "Namor",
         licenses: ["MIT"],
         links: %{"GitHub" => @url, "Demo" => "https://namor.jsonmaur.com"},
         files: ~w(dict lib LICENSE mix.exs README.md)
       ],
       docs: [
+        main: "readme",
         extras: ["LICENSE", "README.md"]
       ]
     ]