mirror of
https://github.com/fluencelabs/wasmer
synced 2024-12-05 02:20:19 +00:00
Improved README
This commit is contained in:
parent
a9a580acee
commit
83baddd6c3
25
README.md
25
README.md
@ -8,13 +8,30 @@
|
||||
|
||||
The [Cranelift](https://github.com/CraneStation/cranelift) compiler is used to compile WebAssembly to native machine code. Once compiled, there are no complex interactions between the application and the runtime (unlike jit compilers, like v8) to reduce surface area for vulnerabilities.
|
||||
|
||||
**THIS PROJECT IS NOT USABLE YET, BUT WILL BE SOON 🙂**
|
||||
|
||||
[Documentation (crates.io)](https://docs.rs/wasmer).
|
||||
|
||||
## Principles
|
||||
|
||||
Wasmer is an open project guided by strong principles, aiming to be modular, flexible and fast. It is open to the community to help set its direction.
|
||||
|
||||
- Modular: the project includes lots of components that have well-defined functions and APIs that work together.
|
||||
- Tested: All WebAssembly spec test cases should be covered.
|
||||
- Developer focused: The APIs are intended to be functional and useful to build powerful tools.
|
||||
- Fast: it should be as fast as possible.
|
||||
|
||||
## Usage
|
||||
|
||||
It can load both the standard binary format (`.wasm`), and the text format
|
||||
defined by the WebAssembly reference interpreter (`.wat`).
|
||||
|
||||
Once installed, you will be able to run:
|
||||
|
||||
```sh
|
||||
wasmer run my_wasm_file.wasm
|
||||
```
|
||||
|
||||
## Building & Running
|
||||
|
||||
To build this project you will need Rust and Cargo.
|
||||
@ -29,6 +46,14 @@ cd wasmer
|
||||
cargo install
|
||||
```
|
||||
|
||||
## Testing
|
||||
|
||||
Tests can be run with:
|
||||
|
||||
```sh
|
||||
cargo test
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT/Apache-2.0
|
||||
|
Loading…
Reference in New Issue
Block a user