Skip to content

Commit

Permalink
chore: update sibling dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
aegir[bot] committed Dec 6, 2023
1 parent f66dd71 commit 6ab5ddc
Showing 1 changed file with 3 additions and 46 deletions.
49 changes: 3 additions & 46 deletions packages/ipns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'

Expand Down Expand Up @@ -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, {
Expand Down Expand Up @@ -122,48 +124,3 @@ 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

```console
$ npm i @helia/ipns
```

### Browser `<script>` tag

Loading this module through a script tag will make it's exports available as `HeliaIpns` in the global namespace.

```html
<script src="https://unpkg.com/@helia/ipns/dist/index.min.js"></script>
```

## API Docs

- <https://ipfs.github.io/helia-ipns/modules/_helia_ipns.html>

## 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

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)

0 comments on commit 6ab5ddc

Please sign in to comment.