From e94634c5c9251dd4021ac51af215d298c84f7f57 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Thu, 9 Oct 2025 08:36:56 +0000 Subject: [PATCH] Update documentation to include all 9 examples Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com> --- CHANGELOG.md | 1 + README.md | 19 +++++++++++-------- RELEASE.md | 11 ++++++++--- docs/faq.md | 15 +++++++++------ 4 files changed, 29 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7fd808f5..6c0c47af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,6 +26,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), - Updated README.md to reference the new dedicated installation guide for complete installation instructions - Removed separate homebrew.md, nix.md, and winget.md pages to eliminate duplication; all installation content is now consolidated in installation.md - Added tabbed interface for installation instructions organized by platform (Linux, macOS, Windows, Nix) using mdbook-tabs preprocessor +- Updated README.md, docs/faq.md, and RELEASE.md to include all 9 examples in the examples directory: brave-search-rs, context7-rs, eval-py, fetch-rs, filesystem-rs, get-open-meteo-weather-js, get-weather-js, gomodule-go, and time-server-js ### Fixed diff --git a/README.md b/README.md index ba67c65e..767cd96c 100644 --- a/README.md +++ b/README.md @@ -365,14 +365,17 @@ Component and expose its functions as MCP tools. Components can be re-used by ot See the [`examples/`](./examples/) directory for a complete list of examples. Here is a selection of examples written in different languages: -| Example | Description | -| ------------------------------------------ | ------------------------------------------------------ | -| [eval-py](examples/eval-py/) | Python code execution sandbox | -| [fetch-rs](examples/fetch-rs/) | HTTP API client for fetching and converting web content | -| [filesystem-rs](examples/filesystem-rs/) | File system operations (read, write, list directories) | -| [get-weather-js](examples/get-weather-js/) | Weather API client for fetching weather data | -| [gomodule-go](examples/gomodule-go/) | Go module information tool | -| [time-server-js](examples/time-server-js/) | JavaScript-based time server component | +| Example | Description | +| -------------------------------------------------------------- | ------------------------------------------------------ | +| [brave-search-rs](examples/brave-search-rs/) | Web search using Brave Search API | +| [context7-rs](examples/context7-rs/) | Search libraries and fetch documentation via Context7 API | +| [eval-py](examples/eval-py/) | Python code execution sandbox | +| [fetch-rs](examples/fetch-rs/) | HTTP API client for fetching and converting web content | +| [filesystem-rs](examples/filesystem-rs/) | File system operations (read, write, list directories) | +| [get-open-meteo-weather-js](examples/get-open-meteo-weather-js/) | Weather data via Open-Meteo API (no API key required) | +| [get-weather-js](examples/get-weather-js/) | Weather API client using OpenWeather API | +| [gomodule-go](examples/gomodule-go/) | Go module information tool | +| [time-server-js](examples/time-server-js/) | JavaScript-based time server component | ## Community Components diff --git a/RELEASE.md b/RELEASE.md index 985e6036..d1fac9b4 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -98,12 +98,17 @@ The [`examples.yml`](.github/workflows/examples.yml) workflow automatically publ - A pull request targeting the `main` branch modifies files in the `examples/**` directory (build only, no publish) **Published examples include:** +- `eval-py` - Python expression evaluator - `fetch-rs` - HTTP fetch example in Rust - `filesystem-rs` - Filesystem operations in Rust -- `get-weather-js` - Weather API example in JavaScript -- `time-server-js` - Time server example in JavaScript -- `eval-py` - Python expression evaluator +- `get-weather-js` - Weather API example in JavaScript using OpenWeather API - `gomodule-go` - Go module information tool +- `time-server-js` - Time server example in JavaScript + +**Additional examples in repository (not yet published to OCI registry):** +- `brave-search-rs` - Web search using Brave Search API +- `context7-rs` - Search libraries and fetch documentation via Context7 API +- `get-open-meteo-weather-js` - Weather data via Open-Meteo API (no API key required) **What the workflow does:** 1. Builds all example components using `just build-examples` diff --git a/docs/faq.md b/docs/faq.md index edf7376c..408d7dd0 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -36,9 +36,9 @@ WebAssembly Components are a standardized way to build portable, secure, and int Wassette supports tools written in any language that can compile to WebAssembly Components. For current language support, see the [WebAssembly Language Support Guide](https://developer.fermyon.com/wasm-languages/webassembly-language-support). The project includes examples in several popular languages: -- **JavaScript** ([time-server-js](https://github.com/microsoft/wassette/tree/main/examples/time-server-js), [get-weather-js](https://github.com/microsoft/wassette/tree/main/examples/get-weather-js)) +- **JavaScript** ([time-server-js](https://github.com/microsoft/wassette/tree/main/examples/time-server-js), [get-weather-js](https://github.com/microsoft/wassette/tree/main/examples/get-weather-js), [get-open-meteo-weather-js](https://github.com/microsoft/wassette/tree/main/examples/get-open-meteo-weather-js)) - **Python** ([eval-py](https://github.com/microsoft/wassette/tree/main/examples/eval-py)) -- **Rust** ([fetch-rs](https://github.com/microsoft/wassette/tree/main/examples/fetch-rs), [filesystem-rs](https://github.com/microsoft/wassette/tree/main/examples/filesystem-rs)) +- **Rust** ([fetch-rs](https://github.com/microsoft/wassette/tree/main/examples/fetch-rs), [filesystem-rs](https://github.com/microsoft/wassette/tree/main/examples/filesystem-rs), [brave-search-rs](https://github.com/microsoft/wassette/tree/main/examples/brave-search-rs), [context7-rs](https://github.com/microsoft/wassette/tree/main/examples/context7-rs)) - **Go** ([gomodule-go](https://github.com/microsoft/wassette/tree/main/examples/gomodule-go)) ### Can I use existing WebAssembly modules with Wassette? @@ -224,9 +224,12 @@ See the [Contributing Guide](https://github.com/microsoft/wassette/blob/main/CON ### Where can I find more examples? The [examples directory](https://github.com/microsoft/wassette/tree/main/examples) contains working examples in multiple languages: -- [Time server (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/time-server-js) -- [Weather API (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/get-weather-js) -- [File system operations (Rust)](https://github.com/microsoft/wassette/tree/main/examples/filesystem-rs) -- [HTTP client (Rust)](https://github.com/microsoft/wassette/tree/main/examples/fetch-rs) +- [Brave Search (Rust)](https://github.com/microsoft/wassette/tree/main/examples/brave-search-rs) +- [Context7 API (Rust)](https://github.com/microsoft/wassette/tree/main/examples/context7-rs) - [Code execution (Python)](https://github.com/microsoft/wassette/tree/main/examples/eval-py) +- [HTTP client (Rust)](https://github.com/microsoft/wassette/tree/main/examples/fetch-rs) +- [File system operations (Rust)](https://github.com/microsoft/wassette/tree/main/examples/filesystem-rs) +- [Weather via Open-Meteo (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/get-open-meteo-weather-js) +- [Weather via OpenWeather (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/get-weather-js) - [Go module info (Go)](https://github.com/microsoft/wassette/tree/main/examples/gomodule-go) +- [Time server (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/time-server-js)