Initial Commit

README.md

@@ -1,4 +1,26 @@
 # dllist
 
-Gleam implementation of a doubly-linked list.
-Allows for a cyclic or terminated lists
+Gleam implementation of a doubly-linked list.
+Allows for a cyclic or terminated lists
+[![Package Version](https://img.shields.io/hexpm/v/dllist)](https://hex.pm/packages/dllist)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/dllist/)
+
+```sh
+gleam add dllist@1
+```
+```gleam
+import dllist
+
+pub fn main() -> Nil {
+  // TODO: An example of the project in use
+}
+```
+
+Further documentation can be found at <https://hexdocs.pm/dllist>.
+
+## Development
+
+```sh
+gleam run   # Run the project
+gleam test  # Run the tests
+```