diff --git a/packages/ipns/README.md b/packages/ipns/README.md index d5ad8aaf..025a5fa2 100644 --- a/packages/ipns/README.md +++ b/packages/ipns/README.md @@ -23,6 +23,7 @@ With IPNSRouting routers: ```typescript import { createHelia } from 'helia' +import { ipns } from '@helia/ipns' import { dht, pubsub } from '@helia/ipns/routing' import { unixfs } from '@helia/unixfs' @@ -55,8 +56,9 @@ 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, { @@ -122,48 +124,3 @@ const cid = name.resolveDns('ipfs.io', { ] }) ``` - -## Table of contents - -- [Install](#install) - - [Browser ` -``` - -## API Docs - -- - -## License - -Licensed under either of - -- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / ) -- MIT ([LICENSE-MIT](LICENSE-MIT) / ) - -## Contribute - -Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-ipns/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. - -Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md). - -Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. - -[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)