simulator

sim/README.md

@@ -0,0 +1,24 @@
+# sim
+
+[![Package Version](https://img.shields.io/hexpm/v/sim)](https://hex.pm/packages/sim)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/sim/)
+
+```sh
+gleam add sim@1
+```
+```gleam
+import sim
+
+pub fn main() -> Nil {
+  // TODO: An example of the project in use
+}
+```
+
+Further documentation can be found at <https://hexdocs.pm/sim>.
+
+## Development
+
+```sh
+gleam run   # Run the project
+gleam test  # Run the tests
+```