From 48e35ad3b0b0c62f936784e4aca70b17c3b0e3f9 Mon Sep 17 00:00:00 2001
From: Hunky Jimpjorps <thechairman@thechairman.info>
Date: Fri, 2 Feb 2024 17:05:12 -0500
Subject: renaming

---
 aoc2023-gleam/README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 aoc2023-gleam/README.md

(limited to 'aoc2023-gleam/README.md')

diff --git a/aoc2023-gleam/README.md b/aoc2023-gleam/README.md
new file mode 100644
index 0000000..3f534e8
--- /dev/null
+++ b/aoc2023-gleam/README.md
@@ -0,0 +1,28 @@
+# aoc2023
+
+[![Package Version](https://img.shields.io/hexpm/v/aoc2023)](https://hex.pm/packages/aoc2023)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/aoc2023/)
+
+## 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 aoc2023
+```
+
+and its documentation can be found at <https://hexdocs.pm/aoc2023>.
+
+## Use
+
+* Set up a solution: `gleam run -m adglent/day <n>`
+* Check against examples: `gleam test -- --modules=day<n>/day<n>_test`
+* Get final answer: `gleam run -m day<n>/solve <p>`
\ No newline at end of file
-- 
cgit v1.2.3