Skip to content

Commit a34e3c5

Browse files
CopilotMossaka
andauthored
Update documentation to include all 9 examples (#376)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Mossaka <5447827+Mossaka@users.noreply.github.com>
1 parent 8817744 commit a34e3c5

File tree

4 files changed

+29
-17
lines changed

4 files changed

+29
-17
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
2626
- Updated README.md to reference the new dedicated installation guide for complete installation instructions
2727
- Removed separate homebrew.md, nix.md, and winget.md pages to eliminate duplication; all installation content is now consolidated in installation.md
2828
- Added tabbed interface for installation instructions organized by platform (Linux, macOS, Windows, Nix) using mdbook-tabs preprocessor
29+
- 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
2930

3031
### Fixed
3132

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -365,14 +365,17 @@ Component and expose its functions as MCP tools. Components can be re-used by ot
365365
See the [`examples/`](./examples/) directory for a complete list of examples. Here is a
366366
selection of examples written in different languages:
367367

368-
| Example | Description |
369-
| ------------------------------------------ | ------------------------------------------------------ |
370-
| [eval-py](examples/eval-py/) | Python code execution sandbox |
371-
| [fetch-rs](examples/fetch-rs/) | HTTP API client for fetching and converting web content |
372-
| [filesystem-rs](examples/filesystem-rs/) | File system operations (read, write, list directories) |
373-
| [get-weather-js](examples/get-weather-js/) | Weather API client for fetching weather data |
374-
| [gomodule-go](examples/gomodule-go/) | Go module information tool |
375-
| [time-server-js](examples/time-server-js/) | JavaScript-based time server component |
368+
| Example | Description |
369+
| -------------------------------------------------------------- | ------------------------------------------------------ |
370+
| [brave-search-rs](examples/brave-search-rs/) | Web search using Brave Search API |
371+
| [context7-rs](examples/context7-rs/) | Search libraries and fetch documentation via Context7 API |
372+
| [eval-py](examples/eval-py/) | Python code execution sandbox |
373+
| [fetch-rs](examples/fetch-rs/) | HTTP API client for fetching and converting web content |
374+
| [filesystem-rs](examples/filesystem-rs/) | File system operations (read, write, list directories) |
375+
| [get-open-meteo-weather-js](examples/get-open-meteo-weather-js/) | Weather data via Open-Meteo API (no API key required) |
376+
| [get-weather-js](examples/get-weather-js/) | Weather API client using OpenWeather API |
377+
| [gomodule-go](examples/gomodule-go/) | Go module information tool |
378+
| [time-server-js](examples/time-server-js/) | JavaScript-based time server component |
376379

377380
## Community Components
378381

RELEASE.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,12 +98,17 @@ The [`examples.yml`](.github/workflows/examples.yml) workflow automatically publ
9898
- A pull request targeting the `main` branch modifies files in the `examples/**` directory (build only, no publish)
9999

100100
**Published examples include:**
101+
- `eval-py` - Python expression evaluator
101102
- `fetch-rs` - HTTP fetch example in Rust
102103
- `filesystem-rs` - Filesystem operations in Rust
103-
- `get-weather-js` - Weather API example in JavaScript
104-
- `time-server-js` - Time server example in JavaScript
105-
- `eval-py` - Python expression evaluator
104+
- `get-weather-js` - Weather API example in JavaScript using OpenWeather API
106105
- `gomodule-go` - Go module information tool
106+
- `time-server-js` - Time server example in JavaScript
107+
108+
**Additional examples in repository (not yet published to OCI registry):**
109+
- `brave-search-rs` - Web search using Brave Search API
110+
- `context7-rs` - Search libraries and fetch documentation via Context7 API
111+
- `get-open-meteo-weather-js` - Weather data via Open-Meteo API (no API key required)
107112

108113
**What the workflow does:**
109114
1. Builds all example components using `just build-examples`

docs/faq.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ WebAssembly Components are a standardized way to build portable, secure, and int
3636
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).
3737

3838
The project includes examples in several popular languages:
39-
- **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))
39+
- **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))
4040
- **Python** ([eval-py](https://github.com/microsoft/wassette/tree/main/examples/eval-py))
41-
- **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))
41+
- **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))
4242
- **Go** ([gomodule-go](https://github.com/microsoft/wassette/tree/main/examples/gomodule-go))
4343

4444
### Can I use existing WebAssembly modules with Wassette?
@@ -224,9 +224,12 @@ See the [Contributing Guide](https://github.com/microsoft/wassette/blob/main/CON
224224
### Where can I find more examples?
225225

226226
The [examples directory](https://github.com/microsoft/wassette/tree/main/examples) contains working examples in multiple languages:
227-
- [Time server (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/time-server-js)
228-
- [Weather API (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/get-weather-js)
229-
- [File system operations (Rust)](https://github.com/microsoft/wassette/tree/main/examples/filesystem-rs)
230-
- [HTTP client (Rust)](https://github.com/microsoft/wassette/tree/main/examples/fetch-rs)
227+
- [Brave Search (Rust)](https://github.com/microsoft/wassette/tree/main/examples/brave-search-rs)
228+
- [Context7 API (Rust)](https://github.com/microsoft/wassette/tree/main/examples/context7-rs)
231229
- [Code execution (Python)](https://github.com/microsoft/wassette/tree/main/examples/eval-py)
230+
- [HTTP client (Rust)](https://github.com/microsoft/wassette/tree/main/examples/fetch-rs)
231+
- [File system operations (Rust)](https://github.com/microsoft/wassette/tree/main/examples/filesystem-rs)
232+
- [Weather via Open-Meteo (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/get-open-meteo-weather-js)
233+
- [Weather via OpenWeather (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/get-weather-js)
232234
- [Go module info (Go)](https://github.com/microsoft/wassette/tree/main/examples/gomodule-go)
235+
- [Time server (JavaScript)](https://github.com/microsoft/wassette/tree/main/examples/time-server-js)

0 commit comments

Comments
 (0)