README.md

Walrus 🌊🐘

Walrus is a WebAssembly transformation library

API Docs | Contributing | Chat

_{Built with 🦀🕸 by The Rust and WebAssembly Working Group}

About

The walrus crate is a Rust library for performing WebAssembly transformations in a robust and ergonomic fashion. The crate is still in its early days but is currently used to power the wasm-bindgen CLI tool and its own internal transformations.

Using walrus will, in the long term, also allow transforming WebAssembly while preserving DWARF debug information to ensure that debugging the final module is just as nice as debugging the intermediate module.

Stay tuned for more information in the future!

Examples

• Check out examples/build-wasm-from-scratch.rs for a quick intro to building a Wasm module from scratch with walrus.
• Check out the wasm-snip project for a relatively simple and self-contained but still Real World example of using walrus.

License

This project is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.