more words for ipns pubsub documentation
License: MIT Signed-off-by: vyzo <vyzo@hackzen.org>
vyzo committed
Mar 31, 2018 at 10:12 UTC
d9cd2929f0531b13dd2a2a04ad49f8e9d57e2d16
1 file changed
+12
-4
docs/experimental-features.md
+12
-4
@@ -372,7 +372,7 @@ ipfs config --json Experimental.ShardingEnabled true
372
373
### In Version
374
375
-0.4.13
375
+0.4.14
376
377
### State
378
@@ -380,8 +380,15 @@ Experimental, default-disabled.
380
381
Utilizes pubsub for publishing ipns records in real time.
382
383
-Note: both the publisher and the resolver nodes need to have the feature
384
-enabled for it to work effectively.
383
+When it is enabled:
384
+- IPNS publishers push records to a name-specific pubsub topic,
385
+ in addition to publishing to the DHT.
386
+- IPNS resolvers subscribe to the name-specific topic and receive newly
387
+ published records through pubsub in real time. Note that the initial resolution
388
+ still goes through the DHT, as there is no message history in pubsub.
389
+
390
+Both the publisher and the resolver nodes need to have the feature enabled for it
391
+to work effectively.
392
393
### How to enable
394
@@ -391,4 +398,5 @@ run your daemon with the `--enable-namesys-pubsub` flag; enables pubsub.
398
399
- [ ] Needs more people to use and report on how well it works
400
- [ ] Add a mechanism for last record distribution on subscription,
394
- so that we don't have to hit the DHT for name resolution at all.
401
+ so that we don't have to hit the DHT for the initial resolution.
402
+ Alternatively, we could republish the last record periodically.