From 8fb4a763ab15019a5743f679d4013a60cc8a8923 Mon Sep 17 00:00:00 2001 From: Daniel Norman <1992255+2color@users.noreply.github.com> Date: Thu, 29 Feb 2024 13:30:05 +0100 Subject: [PATCH] docs: move the package docs to root of repo (#1) 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 --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 29532713..cd5fcdf2 100644 --- a/README.md +++ b/README.md @@ -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 -- +- # License