diff --git a/README.md b/README.md index 624d40891..412dd0a88 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,31 @@
-

jco

-

- JavaScript component toolchain for working with WebAssembly Components -

+ # `jco` - A Bytecode Alliance project + **JavaScript tooling for working with [WebAssembly Components](https://github.com/WebAssembly/component-model)** -

- build status -

+ **A [Bytecode Alliance](https://bytecodealliance.org/) project** + + [![build status](https://github.com/bytecodealliance/jco/workflows/CI/badge.svg)](https://github.com/bytecodealliance/jco/actions?query=workflow%3ACI)
## Overview -`jco` is a fully native JS tool for working with the emerging [WebAssembly Components](https://github.com/WebAssembly/component-model) specification in JavaScript. +`jco` is a fully native JavaScript tool for working with the emerging [WebAssembly Components](https://github.com/WebAssembly/component-model) specification. + +`jco` can convert code between JS and a Wasm component: + +* "Transpile" a Wasm component binary into an ES module that can run in any JS environment. +* "Componentize" JS code and a WIT world into a Wasm component. -Features include: +`jco` also includes: -* "Transpiling" Wasm Component binaries into ES modules that can run in any JS environment. -* Optimization helpers for Components via Binaryen. -* Component builds of [Wasm Tools](https://github.com/bytecodealliance/wasm-tools) helpers, available for use as a library or CLI commands for use in native JS environments. -* "Componentize" for WebAssembly Components from JavaScript sources and a WIT world +* Optimization helpers for components via [Binaryen](https://github.com/WebAssembly/binaryen). +* Component builds of [Wasm Tools](https://github.com/bytecodealliance/wasm-tools) helpers, available in native JS environments for use as a library or via CLI commands. -For creating components in other languages, see the [Cargo Component](https://github.com/bytecodealliance/cargo-Component) project for Rust and [Wit Bindgen](https://github.com/bytecodealliance/wit-bindgen) for various guest bindgen helpers. +For creating components in other languages, see [`cargo component`](https://github.com/bytecodealliance/cargo-component) (for Rust) and [Wit Bindgen](https://github.com/bytecodealliance/wit-bindgen) for various guest language bindings generators. -> **Note**: This is an experimental project, no guarantees are provided for stability or support and breaking changes may be made in future. +> **Note**: This is an experimental project. No guarantees are provided for stability, security or support and breaking changes may be made without notice. ## Installation @@ -33,7 +33,7 @@ For creating components in other languages, see the [Cargo Component](https://gi npm install @bytecodealliance/jco ``` -jco can be used as either a library or as a CLI via the `jco` CLI command. +`jco` can be used either as a library or via the `jco` CLI command. ## Example