docs: update experimental-features doc with IPNS over pubsub changes.
Adin Schmahmann committed
May 20, 2020 at 00:51 UTC
a38987a9dec353fc5dd81c0f491ea1847d48d65a
1 file changed
+9
-5
docs/experimental-features.md
+9
-5
@@ -427,7 +427,9 @@ ipfs config --json Experimental.ShardingEnabled true
427
428
### In Version
429
430
-0.4.14
430
+Introduced: 0.4.14
431
+
432
+Latest Major Change: 0.5.0
433
434
### State
435
@@ -439,10 +441,14 @@ When it is enabled:
441
- IPNS publishers push records to a name-specific pubsub topic,
442
in addition to publishing to the DHT.
443
- IPNS resolvers subscribe to the name-specific topic on first
442
- resolution and receive subsequently published records through pubsub in real time. This makes subsequent resolutions instant, as they are resolved through the local cache. Note that the initial resolution still goes through the DHT, as there is no message history in pubsub.
444
+ resolution and receive subsequently published records through pubsub in real time.
445
+ This makes subsequent resolutions instant, as they are resolved through the local cache.
446
447
Both the publisher and the resolver nodes need to have the feature enabled for it to work effectively.
448
449
+Note: While IPNS pubsub has been available since 0.4.14, it received major changes in 0.5.0.
450
+Users interested in this feature should upgrade to at least 0.5.0
451
+
452
### How to enable
453
454
run your daemon with the `--enable-namesys-pubsub` flag; enables pubsub.
@@ -450,9 +456,7 @@ run your daemon with the `--enable-namesys-pubsub` flag; enables pubsub.
456
### Road to being a real feature
457
458
- [ ] Needs more people to use and report on how well it works
453
-- [ ] Add a mechanism for last record distribution on subscription,
454
- so that we don't have to hit the DHT for the initial resolution.
455
- Alternatively, we could republish the last record periodically.
459
+- [ ] Pubsub enabled as a real feature
460
461
## QUIC
462