Skip to content

Commit 37a0837

Browse files
committed
doc: get the readme ready for release
Signed-off-by: Josh Duffney <jduffney@microsoft.com>
1 parent bfdf1a2 commit 37a0837

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,23 @@
11
<div align="center">
22
<h1 align="center">Wassette</h1>
3-
<p>A security-oriented runtime that runs WebAssembly Components via MCP</p>
3+
<p><b>A security-oriented runtime that runs WebAssembly Components via MCP</b></p>
44

5-
<!-- [![](https://dcbadge.limes.pink/api/server/microsoft-open-source)](https://discord.gg/microsoft-open-source) -->
6-
</div>
5+
<!-- <a href="https://discord.gg/microsoft-open-source">
6+
<img src="https://dcbadge.limes.pink/api/server/microsoft-open-source" alt="Discord" style="height: 25px;">
7+
</a> -->
8+
9+
[Getting started][setup guide] | [Releases] | [Contributing] | [Discord]
710

8-
Wassette extends AI agents by dynamically loading and configuring MCP tools using natural language prompts. It does this by pulling Wasm components from OCI registries or local files, and running them as MCP tools in isolated processes with precisely scoped permissions.
11+
</div>
912

10-
> 🦺 This project is in early development and actively evolving. Expect rapid iteration, breaking changes, and responsiveness to feedback. Please submit issues or reach out with questions!
13+
## Why Wassette?
1114

12-
To learn more about the architecture and design philosophy, see the [Architecture Design Document](docs/architecture-design.md).
15+
- **Convenience**: Wassette makes it easy to extend AI agents with new tools,
16+
all without ever having to leave the chat window.
17+
- **Reusability**: Wasm Components built for Wassette are generic and reusable;
18+
there is nothing MCP-specific about them.
19+
- **Security**: Wassette is built on the Wasmtime security sandbox, providing
20+
browser-grade isolation of tools.
1321

1422
## Installation
1523

@@ -19,7 +27,7 @@ For Linux and macOS, you can install Wassette using the provided install script:
1927
curl -fsSL https://raw.githubusercontent.com/microsoft/wassette/main/install.sh | bash
2028
```
2129

22-
This will detect your platform and install the latest `wassette` binary to your `$PATH`. For Windows, you can download the latest release from the [GitHub Releases page](https://github.com/microsoft/wassette/releases).
30+
This will detect your platform and install the latest `wassette` binary to your `$PATH`. For Windows, you can download the latest release from the [GitHub Releases page][Releases]
2331

2432
## Using Wassette
2533

@@ -84,7 +92,7 @@ selection of examples written in different languages:
8492

8593
## Contributing
8694

87-
Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute to this project.
95+
Please see [CONTRIBUTING.md][Contributing] for more information on how to contribute to this project.
8896

8997
## License
9098

@@ -95,3 +103,6 @@ This project is icensed under the <a href="LICENSE">MIT License</a>.
95103
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft’s Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.
96104

97105
[setup guide]: https://github.com/microsoft/wassette/blob/main/docs/mcp-clients.md
106+
[Contributing]: CONTRIBUTING.md
107+
[Releases]: https://github.com/microsoft/wassette/releases
108+
[Discord]: https://discord.gg/microsoft-open-source

0 commit comments

Comments
 (0)