@helia/ipns 10.2.0 → 10.2.1-bdbda7ae

package/README.md

@@ -169,10 +169,11 @@ for await (const result of name.resolve(publicKey)) {
 
 It is sometimes useful to be able to republish an existing IPNS record
 without needing the private key. This allows you to extend the availability
-of a record that was created elsewhere.
+of a record that was created elsewhere: use `import` to store the record
+locally, then `republish` to broadcast it and keep it alive.
 
-There should be only one republisher per IPNS key. Multiple machines
-republishing the same key flood the routers with redundant writes.
+> **There should be only one republisher per IPNS key.** Multiple machines
+> republishing the same key flood the routers with redundant writes.
 
 ```TypeScript
 import { createHelia } from 'helia'
@@ -193,13 +194,12 @@ const delegatedClient = delegatedRoutingV1HttpApiClient({
 })
 const record = await delegatedClient.getIPNS(parsedCid)
 
-// import the record into the local store (validates and stores it locally,
-// but does not publish it to the routers)
+// bring the record fetched from elsewhere into the local store
 await name.import(parsedCid, record)
 
-// start republishing it; throws RecordObsoleteError if the routers
-// already have a newer record for this key
-const { record: latestRecord } = await name.republish(parsedCid)
+// republish the imported record and keep it alive. Throws
+// RecordObsoleteError if the routing already has a newer record
+await name.republish(parsedCid)
 
 // stop republishing a key
 await name.unpublish(parsedCid)