aboutsummaryrefslogtreecommitdiff
path: root/compat/lustre_http/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'compat/lustre_http/README.md')
-rw-r--r--compat/lustre_http/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/compat/lustre_http/README.md b/compat/lustre_http/README.md
new file mode 100644
index 0000000..1117b93
--- /dev/null
+++ b/compat/lustre_http/README.md
@@ -0,0 +1,17 @@
+# lustre_http
+
+[![Package Version](https://img.shields.io/hexpm/v/lustre_http)](https://hex.pm/packages/lustre_http)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/lustre_http/)
+
+Make HTTP requests from `lustre` via its `cmd` interface.
+Makes life easy when such requests are initiated by the user.
+
+## Quick start
+
+Add to your Gleam project:
+
+```sh
+gleam add lustre_http
+```
+
+View the documentation at <https://hexdocs.pm/lustre_http>, although only `get_as_text` is documented a.t.m.