@helia/ipns 3.0.0 → 4.0.0-031519c

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,26 +17,65 @@
 
 IPNS operations using a Helia node
 
-## Example
+## Example - Getting started
 
 With IPNSRouting routers:
 
 ```typescript
 import { createHelia } from 'helia'
-import { dht, pubsub } from '@helia/ipns/routing'
+import { ipns } from '@helia/ipns'
+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: [
-   dht(helia),
    pubsub(helia)
  ]
 })
 
 // create a public key to publish as an IPNS name
-const keyInfo = await helia.libp2p.keychain.createKey('my-key')
-const peerId = await helia.libp2p.keychain.exportPeerId(keyInfo.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)
@@ -49,14 +88,15 @@ await name.publish(peerId, cid)
 const cid = name.resolve(peerId)
 ```
 
-## Example
+## Example - Using custom DNS over HTTPS resolvers
 
 With default DNSResolver resolvers:
 
 ```typescript
 import { createHelia } from 'helia'
-import { dht, pubsub } from '@helia/ipns/routing'
+import { ipns } from '@helia/ipns'
 import { unixfs } from '@helia/unixfs'
+import { dnsOverHttps } from '@helia/ipns/dns-resolvers'
 
 const helia = await createHelia()
 const name = ipns(helia, {
@@ -68,7 +108,7 @@ const name = ipns(helia, {
 const cid = name.resolveDns('some-domain-with-dnslink-entry.com')
 ```
 
-## Example
+## Example - Resolving a domain with a dnslink entry
 
 Calling `resolveDns` with the `@helia/ipns` instance:
 
@@ -88,7 +128,7 @@ console.info(cid)
 // QmWebsite
 ```
 
-## Example
+## Example - Using DNS-Over-HTTPS
 
 This example uses the Mozilla provided RFC 1035 DNS over HTTPS service. This
 uses binary DNS records so requires extra dependencies to process the
@@ -107,7 +147,7 @@ const cid = name.resolveDns('ipfs.io', {
 })
 ```
 
-## Example
+## Example - Using DNS-JSON-Over-HTTPS
 
 DNS-JSON-Over-HTTPS resolvers use the RFC 8427 `application/dns-json` and can
 result in a smaller browser bundle due to the response being plain JSON.
@@ -123,21 +163,13 @@ const cid = name.resolveDns('ipfs.io', {
 })
 ```
 
-## Table of contents <!-- omit in toc -->
-
-- [Install](#install)
-  - [Browser `<script>` tag](#browser-script-tag)
-- [API Docs](#api-docs)
-- [License](#license)
-- [Contribute](#contribute)
-
-## Install
+# Install
 
 ```console
 $ npm i @helia/ipns
 ```
 
-### Browser `<script>` tag
+## Browser `<script>` tag
 
 Loading this module through a script tag will make it's exports available as `HeliaIpns` in the global namespace.
 
@@ -145,20 +177,20 @@ Loading this module through a script tag will make it's exports available as `He
 <script src="https://unpkg.com/@helia/ipns/dist/index.min.js"></script>
 ```
 
-## API Docs
+# API Docs
 
-- <https://ipfs.github.io/helia-ipns/modules/_helia_ipns.html>
+- <https://ipfs.github.io/helia/modules/_helia_ipns.html>
 
-## License
+# License
 
 Licensed under either of
 
 - Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
 - MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
 
-## Contribute
+# 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.