aboutsummaryrefslogtreecommitdiff
path: root/aoc2023/README.md
diff options
context:
space:
mode:
authorJ.J <thechairman@thechairman.info>2023-11-30 17:10:00 -0500
committerJ.J <thechairman@thechairman.info>2023-11-30 17:10:00 -0500
commit8ab65dc2da1742eb86ec636c50c7018385b68167 (patch)
treec4fd556aca9b867cfa1f2f174128c30857353884 /aoc2023/README.md
parentfafbeaf9e3c09ba7a5bea7e47d5736001f8a5aa1 (diff)
downloadgleam_aoc-8ab65dc2da1742eb86ec636c50c7018385b68167.tar.gz
gleam_aoc-8ab65dc2da1742eb86ec636c50c7018385b68167.zip
prep for 2023, renaming for consistency
Diffstat (limited to 'aoc2023/README.md')
-rw-r--r--aoc2023/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/aoc2023/README.md b/aoc2023/README.md
new file mode 100644
index 0000000..921dfae
--- /dev/null
+++ b/aoc2023/README.md
@@ -0,0 +1,22 @@
+# 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>.