@helia/ipns 4.0.0 → 5.0.0

package/README.md

@@ -8,8 +8,8 @@
 
 [![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
 [![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
-[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-ipns.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-ipns)
-[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-ipns/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-ipns/actions/workflows/js-test-and-release.yml?query=branch%3Amain)
+[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia)
+[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia/main.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia/actions/workflows/main.yml?query=branch%3Amain)
 
 > An implementation of IPNS for Helia
 
@@ -17,20 +17,64 @@
 
 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, libp2pDefaults } from 'helia'
+import { ipns } from '@helia/ipns'
+import { pubsub } from '@helia/ipns/routing'
+import { unixfs } from '@helia/unixfs'
+import { gossipsub } from '@chainsafe/libp2p-gossipsub'
+
+const libp2pOptions = libp2pDefaults()
+libp2pOptions.services.pubsub = gossipsub()
+
+const helia = await createHelia({
+  libp2p: libp2pOptions
+})
 const name = ipns(helia, {
  routers: [
-   libp2p(helia),
    pubsub(helia)
  ]
 })
@@ -141,7 +185,7 @@ Loading this module through a script tag will make it's exports available as `He
 
 # API Docs
 
-- <https://ipfs.github.io/helia-ipns/modules/_helia_ipns.html>
+- <https://ipfs.github.io/helia/modules/_helia_ipns.html>
 
 # License
 
@@ -152,7 +196,7 @@ Licensed under either of
 
 # Contribute
 
-Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-ipns/issues).
+Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia/issues).
 
 Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.