Skip to content

Commit

Permalink
docs: move the package docs to root of repo (#1)
Browse files Browse the repository at this point in the history
Update the root readme to be more descriptive and link to the verified fetch docs
---------

Co-authored-by: Daniel N <2color@users.noreply.github.com>
Co-authored-by: Alex Potsides <alex@achingbrain.net>
  • Loading branch information
3 people authored Feb 29, 2024
1 parent a584a1a commit 8fb4a76
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,20 +11,23 @@
[![codecov](https://img.shields.io/codecov/c/github/ipfs/helia-verified-fetch.svg?style=flat-square)](https://codecov.io/gh/ipfs/helia-verified-fetch)
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/helia-verified-fetch/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/helia-verified-fetch/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> A fetch-like API for obtaining verified & trustless IPFS content on the web

## About

This repo contains a server implementation of the IPFS [Delegated Routing V1 HTTP API](https://specs.ipfs.tech/routing/http-routing-v1/) along with a client that can be used to interact with any compliant server implementation.
This monorepo contains the `@helia/verified-fetch` package and its corresponding interop tests.

# Getting started

See the [**`@helia/verified-fetch`**](./packages/verified-fetch#readme) package for how to get started with the package including usage examples.

# Packages

- [`/packages/interop`](./packages/interop) Interop tests for @helia/verified-fetch
- [`/packages/verified-fetch`](./packages/verified-fetch) A fetch-like API for obtaining verified & trustless IPFS content on the web
- [`@helia/verified-fetch`](./packages/verified-fetch) A fetch-like API for obtaining verified & trustless IPFS content on the web
- [`@helia/verified-fetch-interop`](./packages/interop) Interop tests for @helia/verified-fetch

# API Docs

- <https://ipfs.github.io/helia-verified-fetch>
- <https://ipfs.github.io/helia-verified-fetch/modules.html>

# License

Expand Down

0 comments on commit 8fb4a76

Please sign in to comment.