From cb8a44d128f6205ba7811db4698ebcadd989205c Mon Sep 17 00:00:00 2001
From: Hayleigh Thompson <me@hayleigh.dev>
Date: Sun, 20 Aug 2023 14:16:16 +0100
Subject: :sparkles: Scaffold docs site project.

---
 docs/README.md | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
 create mode 100644 docs/README.md

(limited to 'docs/README.md')

diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..dc75be1
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,24 @@
+# docs
+
+[![Package Version](https://img.shields.io/hexpm/v/docs)](https://hex.pm/packages/docs)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/docs/)
+
+A Gleam project
+
+## Quick start
+
+```sh
+gleam run   # Run the project
+gleam test  # Run the tests
+gleam shell # Run an Erlang shell
+```
+
+## Installation
+
+If available on Hex this package can be added to your Gleam project:
+
+```sh
+gleam add docs
+```
+
+and its documentation can be found at <https://hexdocs.pm/docs>.
-- 
cgit v1.2.3