@helia/http 3.1.3 → 3.1.4-1361bfa5

package/README.md

@@ -30,7 +30,7 @@ repo and examine the changes made.
 
 -->
 
-Exports a `createHeliaHTTP` function that returns an object that implements a lightweight version of the Helia API that functions only over HTTP.
+Exports a `withHTTP` function configures a Helia node that with block brokers and gateways that only run 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/).
 
@@ -39,38 +39,42 @@ Pass it to other modules like @helia/unixfs to fetch files from the distributed
 ## Example
 
 ```typescript
-import { createHeliaHTTP } from '@helia/http'
+import { withHTTP } from '@helia/http'
 import { unixfs } from '@helia/unixfs'
+import { createHelia } from 'helia'
 import { CID } from 'multiformats/cid'
 
-const helia = await createHeliaHTTP()
+const helia = await withHTTP(createHelia()).start()
 
 const fs = unixfs(helia)
 fs.cat(CID.parse('bafyFoo'))
 ```
 
-## Example - with custom gateways and delegated routing endpoints
+## Example - without using this module
+
+It's possible to manually configure your node without using this module.
 
 ```typescript
-import { createHeliaHTTP } from '@helia/http'
-import { trustlessGateway } from '@helia/block-brokers'
-import { delegatedHTTPRouting, httpGatewayRouting } from '@helia/routers'
+import { createHelia } from 'helia'
+import { trustlessGatewayBlockBroker } from '@helia/trustless-gateway-client'
+import { fallbackRouter } from '@helia/fallback-router'
+import { delegatedHTTPRouter } from '@helia/delegated-http-routing-client'
 import { unixfs } from '@helia/unixfs'
 import { CID } from 'multiformats/cid'
 
-const helia = await createHeliaHTTP({
+const helia = await createHelia({
   blockBrokers: [
-    trustlessGateway()
+    trustlessGatewayBlockBroker()
   ],
   routers: [
-    delegatedHTTPRouting({
+    delegatedHTTPRouter({
       url: 'https://delegated-ipfs.dev'
     }),
-    httpGatewayRouting({
+    fallbackRouter({
       gateways: ['https://cloudflare-ipfs.com', 'https://ipfs.io']
     })
   ]
-})
+}).start()
 
 const fs = unixfs(helia)
 fs.cat(CID.parse('bafyFoo'))