Skip to content

README.md

Latest commit

 

History

History
32 lines (26 loc) · 1.33 KB

README.md

File metadata and controls

32 lines (26 loc) · 1.33 KB
Raw

API Docs

Focused documentation for the shared crates in this repository.

Documents

  • Getting Started: dependency setup and first integration steps.
  • Plugin SDK: public types, entrypoints, and error handling.
  • Extension SDK: public types and the config-provider protocol.
  • Effect SDK: public types, entrypoints, and error handling.
  • Protocol Reference: wire formats, kinds, versioning, and JSON examples.
  • Timeouts: the with_timeout helper and runtime budgets.
  • WebAssembly Guests: building core modules and components in Rust, Python, Go and C.
  • Examples: runnable patterns based on the crate examples.

Current Focus

The public surface is centered on four crates: xfetch-plugin-api, xfetch-extension-api, xfetch-effect-api, and xfetch-guest-api (host calls for WebAssembly guests).

Component guests target the WIT package in wit/xfetch-runtime.wit.