Skip to content
This repository has been archived by the owner on Jan 8, 2024. It is now read-only.

chore: fix docs and aegir dep in subpackages #142

Merged
merged 4 commits into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/interop/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
"@libp2p/peer-id-factory": "^3.0.3",
"@libp2p/tcp": "^8.0.4",
"@libp2p/websockets": "^7.0.4",
"aegir": "^41.1.14",
"blockstore-core": "^4.0.1",
"datastore-core": "^9.0.3",
"helia": "^2.0.1",
Expand Down
35 changes: 35 additions & 0 deletions packages/ipns/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,41 @@

* alters the options object passed to the `ipns` factory function

#### Before

```typescript
import { createHelia } from 'helia'
import { ipns } from '@helia/ipns'
import { dht, pubsub } from '@helia/ipns/routing'
import { unixfs } from '@helia/unixfs'

const helia = await createHelia()
const name = ipns(helia, [
dht(helia),
pubsub(helia)
])
```

#### After

```typescript
import { createHelia } from 'helia'
import { ipns } from '@helia/ipns'
import { dnsOverHttps } from '@helia/ipns/dns-resolvers'
import { unixfs } from '@helia/unixfs'

const helia = await createHelia()
const name = ipns(helia, {
routers: [
dht(helia),
pubsub(helia)
],
resolvers: [
dnsOverHttps('https://private-dns-server.me/dns-query'),
]
})
```

### Features

* support DNS over HTTPS and DNS-JSON over HTTPS ([#55](https://github.com/ipfs/helia-ipns/issues/55)) ([2ac0e8b](https://github.com/ipfs/helia-ipns/commit/2ac0e8b26556b73961e67191c564ac2b18d32b31))
Expand Down
1 change: 1 addition & 0 deletions packages/ipns/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,7 @@
"@libp2p/interface": "^0.1.4",
"@libp2p/peer-id-factory": "^3.0.3",
"@types/dns-packet": "^5.6.4",
"aegir": "^41.1.14",
"datastore-core": "^9.0.3",
"sinon": "^17.0.0",
"sinon-ts": "^1.0.0"
Expand Down
4 changes: 3 additions & 1 deletion packages/ipns/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
*
* ```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 @@ -41,8 +42,9 @@
*
* ```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