Skip to content
This repository was archived by the owner on Oct 30, 2023. It is now read-only.

Commit 157393b

Browse files
deps(dev): bump aegir from 40.0.13 to 41.0.0 (#27)
Bumps [aegir](https://github.com/ipfs/aegir) from 40.0.13 to 41.0.0. - [Release notes](https://github.com/ipfs/aegir/releases) - [Changelog](https://github.com/ipfs/aegir/blob/master/CHANGELOG.md) - [Commits](ipfs/aegir@v40.0.13...v41.0.0) --- updated-dependencies: - dependency-name: aegir dependency-type: direct:development update-type: version-update:semver-major ... --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: achingbrain <[email protected]>
1 parent 3edb929 commit 157393b

File tree

3 files changed

+14
-12
lines changed

3 files changed

+14
-12
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,14 @@
99
1010
## Table of contents <!-- omit in toc -->
1111

12-
- [About](#about)
1312
- [Install](#install)
1413
- [Browser `<script>` tag](#browser-script-tag)
14+
- [About](#about)
1515
- [Example](#example)
1616
- [API Docs](#api-docs)
1717
- [License](#license)
1818
- [Contribution](#contribution)
1919

20-
## About
21-
22-
This is an implementation of the libp2p [content routing interface](https://libp2p.github.io/js-libp2p-interfaces/interfaces/_libp2p_interface_content_routing.ContentRouting.html) that uses an [IPNI](https://github.com/ipni/specs) HTTP endpoint.
23-
24-
An alternative is [HTTP Routing V1](https://github.com/libp2p/js-reframe-content-routing) (previously known as Reframe) but the advantage of IPNI at least as of 2023-05-19 is that it returns results in a streaming fashion which can be faster. Note that this will change with the rollout of [IPIP-410](https://github.com/ipfs/specs/pull/410), at which point one can use the HTTP Routing V1 interface/implementation directly.
25-
2620
## Install
2721

2822
```console
@@ -37,6 +31,12 @@ Loading this module through a script tag will make it's exports available as `Li
3731
<script src="https://unpkg.com/@libp2p/ipni-content-routing/dist/index.min.js"></script>
3832
```
3933

34+
## About
35+
36+
This is an implementation of the libp2p [content routing interface](https://libp2p.github.io/js-libp2p-interfaces/interfaces/_libp2p_interface_content_routing.ContentRouting.html) that uses an [IPNI](https://github.com/ipni/specs) HTTP endpoint.
37+
38+
An alternative is [HTTP Routing V1](https://github.com/libp2p/js-reframe-content-routing) (previously known as Reframe) but the advantage of IPNI at least as of 2023-05-19 is that it returns results in a streaming fashion which can be faster. Note that this will change with the rollout of [IPIP-410](https://github.com/ipfs/specs/pull/410), at which point one can use the HTTP Routing V1 interface/implementation directly.
39+
4040
## Example
4141

4242
```js

package.json

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@
1111
"bugs": {
1212
"url": "https://github.com/libp2p/js-ipni-content-routing/issues"
1313
},
14-
"engines": {
15-
"node": ">=16.0.0",
16-
"npm": ">=7.0.0"
17-
},
1814
"type": "module",
1915
"types": "./dist/src/index.d.ts",
2016
"files": [
@@ -32,6 +28,7 @@
3228
"eslintConfig": {
3329
"extends": "ipfs",
3430
"parserOptions": {
31+
"project": true,
3532
"sourceType": "module"
3633
}
3734
},
@@ -149,7 +146,7 @@
149146
},
150147
"devDependencies": {
151148
"@libp2p/peer-id-factory": "^3.0.2",
152-
"aegir": "^40.0.8",
149+
"aegir": "^41.0.0",
153150
"body-parser": "^1.20.2",
154151
"it-all": "^3.0.1"
155152
}

typedoc.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"entryPoints": [
3+
"./src/index.ts"
4+
]
5+
}

0 commit comments

Comments
 (0)