@helia/http 0.9.0 → 1.0.0

package/README.md

@@ -15,6 +15,8 @@
 
 Exports a `createHeliaHTTP` function that returns an object that implements a lightweight version of the Helia API that functions only over HTTP.
 
+By default, content and peer routing are requests are resolved using the [Delegated HTTP Routing API](https://specs.ipfs.tech/routing/http-routing-v1/) and blocks are fetched from [Trustless Gateways](https://specs.ipfs.tech/http-gateways/trustless-gateway/).
+
 Pass it to other modules like @helia/unixfs to fetch files from the distributed web.
 
 ## Example
@@ -30,6 +32,30 @@ const fs = unixfs(helia)
 fs.cat(CID.parse('bafyFoo'))
 ```
 
+## Example - with custom gateways and delegated routing endpoints
+
+```typescript
+import { createHeliaHTTP } from '@helia/http'
+import { trustlessGateway } from '@helia/block-brokers'
+import { delegatedHTTPRouting } from '@helia/routers'
+import { unixfs } from '@helia/unixfs'
+import { CID } from 'multiformats/cid'
+
+const helia = await createHeliaHTTP({
+  blockBrokers: [
+    trustlessGateway({
+      gateways: ['https://cloudflare-ipfs.com', 'https://ipfs.io'],
+    }),
+  ],
+  routers: [
+    delegatedHTTPRouting('https://delegated-ipfs.dev')
+  ]
+})
+
+const fs = unixfs(helia)
+fs.cat(CID.parse('bafyFoo'))
+```
+
 # Install
 
 ```console