@helia/verified-fetch 3.1.0 → 3.2.0

package/README.md

@@ -664,6 +664,8 @@ Verified‑fetch can now be extended to alter how it handles requests by using p
 Plugins are classes that extend the `BasePlugin` class and implement the `VerifiedFetchPlugin`
 interface. They are instantiated with `PluginOptions` when the `VerifiedFetch` class is created.
 
+### Plugin Interface
+
 Each plugin must implement two methods:
 
 - **`canHandle(context: PluginContext): boolean`**
@@ -678,6 +680,8 @@ Each plugin must implement two methods:
   - **Throw a `PluginError`**: This logs a non-fatal error and continues the pipeline.
   - **Throw a `PluginFatalError`**: This logs a fatal error and stops the pipeline immediately.
 
+### Plugin Pipeline
+
 Plugins are executed in a chain (a **plugin pipeline**):
 
 1. **Initialization:**
@@ -724,6 +728,29 @@ Please see the original discussion on extensibility in [Issue #167](https://gith
 
 ***
 
+### Non-default plugins provided by this library
+
+#### `dir-index-html-plugin`
+
+This plugin is used to serve dag-pb/unixfs without an `index.html` child as HTML directory listing of the content requested.
+
+#### `dag-cbor-html-preview-plugin`
+
+This plugin is used to serve the requested dag-cbor object as HTML when the Accept header includes `text/html`.
+
+## Example - Using the plugins
+
+```typescript
+import { createVerifiedFetch } from '@helia/verified-fetch'
+import { dagCborHtmlPreviewPluginFactory, dirIndexHtmlPluginFactory } from '@helia/verified-fetch/plugins'
+import { createHelia } from 'helia'
+
+const helia = await createHelia()
+const fetch = await createVerifiedFetch(helia, {
+  plugins: [dagCborHtmlPreviewPluginFactory, dirIndexHtmlPluginFactory, ]
+})
+```
+
 ### Extending Verified‑Fetch with Custom Plugins
 
 To add your own plugin: