Skip to content
This repository was archived by the owner on Feb 12, 2024. It is now read-only.

Commit 292e36c

Browse files
author
Alan Shaw
authored
docs: revert dht message (#1986)
Add back the message warning users about the (lack of) DHT. License: MIT Signed-off-by: Alan Shaw <[email protected]>
1 parent 7f1fb26 commit 292e36c

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ You can check the development status at the [Kanban Board](https://waffle.io/ipf
3434

3535
[![Throughput Graph](https://graphs.waffle.io/ipfs/js-ipfs/throughput.svg)](https://waffle.io/ipfs/js-ipfs/metrics/throughput)
3636

37+
**Please read this:** The [DHT](https://en.wikipedia.org/wiki/Distributed_hash_table), a fundamental piece for automatic content and peer discovery is not yet complete. There are multiple applications that can be built without this service but nevertheless it is fundamental to getting that magic IPFS experience. The current status is that implementation is done and merged and we're working on performance issues. Expect the DHT to be available in a release very soon.
38+
3739
[**`Weekly Core Dev Calls`**](https://github.com/ipfs/team-mgmt/issues/650)
3840

3941
## Tech Lead
@@ -344,8 +346,8 @@ You can see the bundle in action in the [custom libp2p example](examples/custom-
344346
- `[PeerDiscovery.tag]` (object): configuration for a peer discovery module
345347
- `enabled` (boolean): whether this module is enabled or disabled
346348
- `[custom config]` (any): other keys are specific to the module
347-
- `dht` (object): Configuration options for the DHT
348-
- `enabled` (boolean): whether the DHT is enabled or not (default `true` in Node.js and `false` in the browser)
349+
- `dht` (object): Configuration options for the DHT (WARNING: the current DHT implementation has performance issues, your mileage may vary)
350+
- `enabled` (boolean): whether the DHT is enabled or not (default `false`)
349351
- `kBucketSize` (number): bucket size (default `20`)
350352
- `randomWalk` (object): configuration for random walk
351353
- `enabled` (boolean): whether random DHT walking is enabled (default `false`)

0 commit comments

Comments
 (0)