From b4103464c1877981795e0d377a485dea97406fab Mon Sep 17 00:00:00 2001 From: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com> Date: Thu, 9 Jan 2025 14:02:20 -0600 Subject: [PATCH] docs: fix server timing docs and generate new readme --- packages/verified-fetch/README.md | 8 ++++++++ packages/verified-fetch/src/index.ts | 4 ++-- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/packages/verified-fetch/README.md b/packages/verified-fetch/README.md index 49db286..0f5f8af 100644 --- a/packages/verified-fetch/README.md +++ b/packages/verified-fetch/README.md @@ -635,6 +635,14 @@ Some known header specifications: - - +#### Server Timing headers + +By default, we do not include Server Timing headers in responses. If you want to include them, you can pass an +`includeServerTiming` option to the `createVerifiedFetch` function to include them in all future responses. You can +also pass the `includeServerTiming` option to each fetch call to include them only for that specific response. + +See PR where this was added, , for more information. + ### Possible Scenarios that could cause confusion #### Attempting to fetch the CID for content that does not make sense diff --git a/packages/verified-fetch/src/index.ts b/packages/verified-fetch/src/index.ts index 3efd80d..1cff7af 100644 --- a/packages/verified-fetch/src/index.ts +++ b/packages/verified-fetch/src/index.ts @@ -606,11 +606,11 @@ * * #### Server Timing headers * - * By default, we do not include Server Timing headers in the response. If you want to include them, you can pass an + * By default, we do not include Server Timing headers in responses. If you want to include them, you can pass an * `includeServerTiming` option to the `createVerifiedFetch` function to include them in all future responses. You can * also pass the `includeServerTiming` option to each fetch call to include them only for that specific response. * - * @see https://github.com/ipfs/helia-verified-fetch/pull/164 for more information. + * See PR where this was added, https://github.com/ipfs/helia-verified-fetch/pull/164, for more information. * * ### Possible Scenarios that could cause confusion *