add README.md

moonbitlang · Mar 25, 2024 · 9fddece · 9fddece
1 parent 540a5ed
commit 9fddece
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/immutable_hashmap/README.md b/immutable_hashmap/README.md
@@ -0,0 +1,17 @@
+This package provides an immutable hash map data structure.
+
+## Basic usage
+```
+test {
+  let h =
+    @immutable_hashmap.empty()
+    .add(1, 1)
+    .add(2, 2)
+  let h2 = h.add(3, 3)
+  @assert.assert_eq(h.find(3), None)
+  @assert.assert_eq(h2.find(3), Some(3))
+}
+```
+
+## TODO
+More API, in particular removal.