@helia/ipns 4.0.0-3477b27 → 4.0.0-5a87bbd

package/README.md

@@ -17,20 +17,58 @@
 
 IPNS operations using a Helia node
 
-## Example - Using libp2p and pubsub routers
+## Example - Getting started
 
 With IPNSRouting routers:
 
 ```typescript
 import { createHelia } from 'helia'
 import { ipns } from '@helia/ipns'
-import { libp2p, pubsub } from '@helia/ipns/routing'
+import { unixfs } from '@helia/unixfs'
+
+const helia = await createHelia()
+const name = ipns(helia)
+
+// create a public key to publish as an IPNS name
+const keyInfo = await helia.libp2p.services.keychain.createKey('my-key')
+const peerId = await helia.libp2p.services.keychain.exportPeerId(keyInfo.name)
+
+// store some data to publish
+const fs = unixfs(helia)
+const cid = await fs.add(Uint8Array.from([0, 1, 2, 3, 4]))
+
+// publish the name
+await name.publish(peerId, cid)
+
+// resolve the name
+const cid = name.resolve(peerId)
+```
+
+## Example - Using custom PubSub router
+
+Additional IPNS routers can be configured - these enable alternative means to
+publish and resolve IPNS names.
+
+One example is the PubSub router - this requires an instance of Helia with
+libp2p PubSub configured.
+
+It works by subscribing to a pubsub topic for each IPNS name that we try to
+resolve. Updated IPNS records are shared on these topics so an update must
+occur before the name is resolvable.
+
+This router is only suitable for networks where IPNS updates are frequent
+and multiple peers are listening on the topic(s), otherwise update messages
+may fail to be published with "Insufficient peers" errors.
+
+```typescript
+import { createHelia } from 'helia'
+import { ipns } from '@helia/ipns'
+import { pubsub } from '@helia/ipns/routing'
 import { unixfs } from '@helia/unixfs'
 
 const helia = await createHelia()
 const name = ipns(helia, {
  routers: [
-   libp2p(helia),
    pubsub(helia)
  ]
 })