Add README.md

randomairborne · Apr 14, 2024 · 83fabd6 · 83fabd6
1 parent e35988b
commit 83fabd6
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,15 @@
+# expiringmap
+
+A rust library implementing a TTL map.
+
+```rust
+use std::time::Duration;
+use expiringmap::ExpiringMap;
+
+fn main() {
+    let mut map = ExpiringMap::new();
+    map.insert("key", "value", Duration::from_millis(50));
+    std::thread::sleep(Duration::from_millis(60));
+    assert!(map.get(&"key").is_none());
+}
+```