aboutsummaryrefslogtreecommitdiff
path: root/gleam/aoc2017/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'gleam/aoc2017/README.md')
-rw-r--r--gleam/aoc2017/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/gleam/aoc2017/README.md b/gleam/aoc2017/README.md
new file mode 100644
index 0000000..9714473
--- /dev/null
+++ b/gleam/aoc2017/README.md
@@ -0,0 +1,25 @@
+# aoc2017_gleam
+
+[![Package Version](https://img.shields.io/hexpm/v/aoc2017_gleam)](https://hex.pm/packages/aoc2017_gleam)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/aoc2017_gleam/)
+
+```sh
+gleam add aoc2017_gleam
+```
+```gleam
+import aoc2017_gleam
+
+pub fn main() {
+ // TODO: An example of the project in use
+}
+```
+
+Further documentation can be found at <https://hexdocs.pm/aoc2017_gleam>.
+
+## Development
+
+```sh
+gleam run # Run the project
+gleam test # Run the tests
+gleam shell # Run an Erlang shell
+```