Add a readme

beajeanm · Aug 7, 2022 · b330702 · b330702
1 parent 2327a57
commit b330702
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# Dream Htmx - Utilities methods for interacting with Htmx in Dream
+
+[![Actions Status](https://github.com/beajeanm/dream-htmx/workflows/CI/badge.svg)](https://github.com/beajeanm/dream-htmx/actions)
+
+See [Htmx documentation](https://htmx.org/docs/#requests) for details about the functinality offered by theis library.
+The lastest documentation can be found at [https://beajeanm.github.io/dream-htmx/dream-htmx/](https://beajeanm.github.io/dream-htmx/dream-htmx/)
+
+Install with:
+```
+$ opam install dream-htmx
+```