Skip to content

Update README and related documents to include all 9 examples #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 9, 2025
Merged

Update README and related documents to include all 9 examples #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link

Copilot AI Oct 9, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The CHANGELOG.md has been updated to document this change, which is required for any Pull Request that makes changes to the codebase according to the changelog management guidelines.

Copilot generated this review using guidance from repository custom instructions.

### Fixed

Expand Down
19 changes: 11 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 8 additions & 3 deletions RELEASE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
15 changes: 9 additions & 6 deletions docs/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down Expand Up @@ -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)