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

Update README to be clear about the API it conforms to and relate it to other projects. #3

Closed
BigLep opened this issue May 2, 2023 · 4 comments · Fixed by #11
Closed

Update README to be clear about the API it conforms to and relate it to other projects. #3

BigLep opened this issue May 2, 2023 · 4 comments · Fixed by #11
Labels
released

Comments

@BigLep
Copy link
Contributor

BigLep commented May 2, 2023 •
edited
Loading

Some README update suggestions:

  1. Link to the spec it conforms to (https://github.com/ipni/specs )
  2. Point to https://github.com/libp2p/js-reframe-content-routing as an alternative to consider if don't want to tie directly to the IPNI interface.
@aschmahmann
Copy link

This conforms to https://github.com/ipfs/specs/blob/main/routing/ROUTING_V1_HTTP.md right?

Unfortunately not, this is the custom IPNI HTTP API. The one that should be renamed to indicate routing-v1 is https://github.com/libp2p/js-reframe-content-routing.

Note: the reason the IPNI specific API was necessary for https://github.com/ipfs-shipyard/helia-service-worker-gateway, where this code was pulled from, is that there is not (as far as I know) a publicly run endpoint that ran routing-v1 for the IPFS Public DHT but cid.contact can get you access to DHT results via IPNI. Once ipfs/specs#388 is landed then asking cid.contact to support both DHT and IPNI results via their routing-v1 endpoint seems pretty doable.

@BigLep BigLep changed the title Update package name to be clear about the API it conforms to? Update README to be clear about the API it conforms to and relate it to other projects. May 3, 2023
@BigLep
Copy link
Contributor Author

BigLep commented May 3, 2023

Ack - all good info @aschmahmann . Thanks. I updated the issue description of what I think we should do (README updates). I also created a naming/readme issue in libp2p/js-delegated-routing-v1-http-api-content-routing#5

achingbrain added a commit that referenced this issue May 19, 2023
@achingbrain
docs: update readme with api info
a80b9bf 
Updates the readme to link to the ipni spec and also http routing v1.

Fixes #3
@achingbrain achingbrain mentioned this issue May 19, 2023
Merged
@pcfreak30
Copy link

A bit related, but I am building on these libraries and given the main IPFS project hosted instance is cid.contact for both https://github.com/libp2p/js-ipni-content-routing and https://github.com/libp2p/js-reframe-content-routing I am confused on what their differences are?

Would appreciate clarification. I have not read any specs, but it feels like theres a lot of overlap and I'm not sure if/when one should be used over the other.

Kudos.

achingbrain added a commit that referenced this issue Aug 5, 2023
@achingbrain @BigLep
docs: update readme with api info (#11)
07eeff4 
Updates the readme to link to the ipni spec and also http routing v1.

Fixes #3

---------

Co-authored-by: Steve Loeppky <[email protected]>
github-actions bot pushed a commit that referenced this issue Aug 5, 2023
@semantic-release-bot
chore(release): 1.0.2 [skip ci]
e5a1670 
## [1.0.2](v1.0.1...v1.0.2) (2023-08-05)

### Trivial Changes

* Update .github/workflows/stale.yml [skip ci] ([93396ea](93396ea))
* Update .github/workflows/stale.yml [skip ci] ([54703e3](54703e3))
* Update .github/workflows/stale.yml [skip ci] ([6953529](6953529))

### Documentation

* update readme with api info ([#11](#11)) ([07eeff4](07eeff4)), closes [#3](#3)

### Dependencies

* **dev:** bump aegir from 39.0.13 to 40.0.8 ([#17](#17)) ([251be23](251be23))
@github-actions
Copy link

github-actions bot commented Aug 5, 2023

🎉 This issue has been resolved in version 1.0.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
released
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: update readme with api info libp2p/js-ipni-content-routing
3 participants
@pcfreak30 @BigLep @aschmahmann