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

Commit 07eeff4

Browse files
achingbrainBigLep
andauthored
docs: update readme with api info (#11)
Updates the readme to link to the ipni spec and also http routing v1. Fixes #3 --------- Co-authored-by: Steve Loeppky <stvn@loeppky.com>
1 parent 251be23 commit 07eeff4

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

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

12+
- [About](#about)
1213
- [Install](#install)
1314
- [Browser `<script>` tag](#browser-script-tag)
1415
- [Example](#example)
1516
- [API Docs](#api-docs)
1617
- [License](#license)
1718
- [Contribution](#contribution)
1819

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+
1926
## Install
2027

2128
```console

0 commit comments

Comments
 (0)