From 78b1e20b93356b4d52eee60867b71db39bffb862 Mon Sep 17 00:00:00 2001
From: Runxi Yu <me@runxiyu.org>
Date: Wed, 17 Sep 2025 08:19:22 +0800
Subject: [PATCH] Add TOC to README

---
 README.md | 34 ++++++++++++++++++++++++++++++++++

diff --git a/README.md b/README.md
index 1d2449054620cc53e752483e9eaf311e405b44e8..628ee3f46fd810e598d8ceff7e6bd853d25a544b 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,40 @@
 This module provides various general-purpose data structures for use in the
 Hare programming language.
 
+## Implemented
+
+- Map-like interface
+  - B-tree map
+  - Red-black tree map
+  - Generic hashmap
+    - Convenience wrapper: Fowler-Noll-Vo hashmap
+    - Convenience wrapper: SipHash hashmap
+  - Generic Swiss table
+    - Convenience wrapper: Fowler-Noll-Vo Swiss table
+    - Convenience wrapper: SipHash Swiss table
+  - Trivial linear slice map
+  - Sorted binary search slice map
+- Set-like interface
+  - Generic bloom filter
+    - Convenience wrapper: Fowler-Noll-Vo bloom filter
+    - Convenience wrapper: SipHash bloom filter
+
+## Planned
+
+- Map-like interface
+  - B+-tree map
+  - LSM-tree map
+  - Order-statistic tree map
+  - Robin-Hood hashmap
+  - Generic LRU cache
+  - Generic LFU cache
+  - TinyLFU cache
+  - Trie map (maybe radix tree?)
+- Set-like interface
+  - Cuckoo filter
+- Ring buffer
+- Binary heap
+
 ## Note
 
 The maintainers of Hare would not recommend using this library.

-- 
2.48.1