@helia/ipns 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -46
- package/dist/index.min.js +4 -4
- package/dist/src/index.d.ts +4 -2
- package/dist/src/index.d.ts.map +1 -1
- package/dist/src/index.js +3 -1
- package/dist/src/index.js.map +1 -1
- package/package.json +2 -1
- package/src/index.ts +4 -2
package/README.md
CHANGED
|
@@ -23,6 +23,7 @@ With IPNSRouting routers:
|
|
|
23
23
|
|
|
24
24
|
```typescript
|
|
25
25
|
import { createHelia } from 'helia'
|
|
26
|
+
import { ipns } from '@helia/ipns'
|
|
26
27
|
import { dht, pubsub } from '@helia/ipns/routing'
|
|
27
28
|
import { unixfs } from '@helia/unixfs'
|
|
28
29
|
|
|
@@ -55,8 +56,9 @@ With default DNSResolver resolvers:
|
|
|
55
56
|
|
|
56
57
|
```typescript
|
|
57
58
|
import { createHelia } from 'helia'
|
|
58
|
-
import {
|
|
59
|
+
import { ipns } from '@helia/ipns'
|
|
59
60
|
import { unixfs } from '@helia/unixfs'
|
|
61
|
+
import { dnsOverHttps } from '@helia/ipns/dns-resolvers'
|
|
60
62
|
|
|
61
63
|
const helia = await createHelia()
|
|
62
64
|
const name = ipns(helia, {
|
|
@@ -122,48 +124,3 @@ const cid = name.resolveDns('ipfs.io', {
|
|
|
122
124
|
]
|
|
123
125
|
})
|
|
124
126
|
```
|
|
125
|
-
|
|
126
|
-
## Table of contents <!-- omit in toc -->
|
|
127
|
-
|
|
128
|
-
- [Install](#install)
|
|
129
|
-
- [Browser `<script>` tag](#browser-script-tag)
|
|
130
|
-
- [API Docs](#api-docs)
|
|
131
|
-
- [License](#license)
|
|
132
|
-
- [Contribute](#contribute)
|
|
133
|
-
|
|
134
|
-
## Install
|
|
135
|
-
|
|
136
|
-
```console
|
|
137
|
-
$ npm i @helia/ipns
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
### Browser `<script>` tag
|
|
141
|
-
|
|
142
|
-
Loading this module through a script tag will make it's exports available as `HeliaIpns` in the global namespace.
|
|
143
|
-
|
|
144
|
-
```html
|
|
145
|
-
<script src="https://unpkg.com/@helia/ipns/dist/index.min.js"></script>
|
|
146
|
-
```
|
|
147
|
-
|
|
148
|
-
## API Docs
|
|
149
|
-
|
|
150
|
-
- <https://ipfs.github.io/helia-ipns/modules/_helia_ipns.html>
|
|
151
|
-
|
|
152
|
-
## License
|
|
153
|
-
|
|
154
|
-
Licensed under either of
|
|
155
|
-
|
|
156
|
-
- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
|
|
157
|
-
- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
|
|
158
|
-
|
|
159
|
-
## Contribute
|
|
160
|
-
|
|
161
|
-
Contributions welcome! Please check out [the issues](https://github.com/ipfs/helia-ipns/issues).
|
|
162
|
-
|
|
163
|
-
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.
|
|
164
|
-
|
|
165
|
-
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).
|
|
166
|
-
|
|
167
|
-
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.
|
|
168
|
-
|
|
169
|
-
[](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)
|