1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8442abb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Map
+
+Available at [https://guyonvarch.gitlab.io/map](https://guyonvarch.gitlab.io/map).
+
+## Gettings started
+
+Start the environment with:
+
+```bash
+./dev start
+```
+
+Later, stop the environment with:
+
+```bash
+./dev stop
+```
+
+## Deploy
+
+```bash
+nix-shell --run ./deploy
+```
+
+## Bucklescript links
+
+- [Documentation](https://bucklescript.github.io/docs/en/interop-overview)
+- [Ocaml std API](https://caml.inria.fr/pub/docs/manual-ocaml-4.02/stdlib.html)
+- [Libraries](https://bucklescript.github.io/bucklescript/api/index.html)