Updates

indexes-search/hyper-p2p-bloom-gossip/README.md

@@ -1,28 +1,38 @@
 # hyper-p2p-bloom-gossip
 
-**Status:** scaffold (`0.0.0-scaffold`) · **Protocol:** `bloom-gossip/v1` · **Wave:** 8
+Probabilistic set membership filter with `bloom-add` gossip over Hyperswarm.
 
-Bloom filter gossip.
+**Category:** indexes-search
 
-## Holepunch references (inspiration only)
+**Protocol:** `bloom-gossip/v1`
 
-- `hyper-p2p-dedup-filter`
+## When to use
 
-> This module composes on Hyperswarm/Hypercore — it does **not** re-implement upstream packages.
+Cheap “maybe seen” checks for peer IDs, hashes, or cache keys replicated across a swarm.
 
-## Composes with
+## When not to use
 
-- `hyper-p2p-gossip-mesh`
+When false positives are unacceptable without secondary verification, or when exact set membership is required locally only.
 
-## Planned API
+## Quick start
 
-- `constructor(opts)` — topic, optional keyPair
-- `getStats()` — scaffold counters
-- `ready()` — no-op until implemented
-- Domain methods — throw `not implemented: scaffold` until Wave 8+ pass
+```js
+const { HyperP2PBloomGossip } = require('hyper-p2p-bloom-gossip')
+const mod = new HyperP2PBloomGossip({ topic: process.argv[2] })
+await mod.ready()
+mod.add('peer-abc')
+console.log(mod.mightContain('peer-abc'), mod.exportBits())
+await mod.close()
+```
 
-## Layout
+## Docs
 
-`modules/indexes-search/hyper-p2p-bloom-gossip/`
+- [docs/api.md](docs/api.md)
+- [docs/architecture.md](docs/architecture.md)
+- [../../_shared/PRODUCTION.md](../../_shared/PRODUCTION.md)
 
-See [`modules/_shared/MODULE_SYSTEM.md`](../../_shared/MODULE_SYSTEM.md).
+## Test
+
+```bash
+npm install && npm test
+```