Skip to content

Commit 663fcfa

Browse files
Re-organize README.md
1 parent d30a1de commit 663fcfa

File tree

1 file changed

+39
-10
lines changed

1 file changed

+39
-10
lines changed

README.md

Lines changed: 39 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,52 @@
1-
<img alt="WAKit Icon" src="https://raw.github.com/wiki/akkyie/wakit/images/wakit_icon.png" width="100px">
1+
<img alt="WasmKit Icon" src="https://raw.github.com/wiki/akkyie/wakit/images/wakit_icon.png" width="100px">
22

33
# WasmKit
44

5-
A WebAssembly runtime written in Swift. Originally developed and maintained by [@akkyie](https://github.com/akkyie).
6-
7-
Implements all of WebAssembly 2.0 binary parsing and execution core spec, with an exclusion of SIMD instructions. The validation and text format parts of the spec are not implemented yet.
8-
9-
It also has rudimentary support for [WASI](https://wasi.dev) with only a few WASI imports implemented currently, with a goal of eventual full support for `wasi_snapshot_preview1`. See `WASI` module for more details.
5+
**WasmKit** is a standalone WebAssembly runtime written in Swift.
106

117
## Usage
128

139
### Command Line Tool
1410

11+
WasmKit provides a command line tool to run WebAssembly binaries compliant with WASI.
12+
1513
```sh
16-
$ # Usage: wasmkit-cli run <path> <functionName> [<arguments>] ...
17-
$ swift run wasmkit-cli run Examples/wasm/fib.wasm fib i32:10
18-
[I32(89)]
14+
$ git clone https://github.com/swiftwasm/WasmKit.git
15+
$ cd WasmKit
16+
$ swift run wasmkit-cli run ./Examples/hello.wasm
17+
Hello, World!
1918
```
2019

2120
### As a Library
2221

2322
#### Swift Package Manager
2423

25-
Add the URL of this repository to your `Package.swift` manifest. Then add the `WasmKit` library product as dependency to the target you'd like to use it with.
24+
You can use WasmKit as a [Swift Package Manager](https://www.swift.org/documentation/package-manager/) dependency by adding the following to your `Package.swift` file:
25+
26+
```swift
27+
dependencies: [
28+
.package(url: "https://github.com/swiftwasm/WasmKit.git", from: "0.0.5"),
29+
],
30+
```
31+
32+
You can find API documentation on the [Swift Package Index](https://swiftpackageindex.com/swiftwasm/WasmKit/main/documentation/wasmkit).
33+
34+
35+
## Implementation Status
36+
37+
| Category | Feature | Status |
38+
|----------|---------|--------|
39+
| WebAssembly MVP | Parsing binary format | ✅ Implemented |
40+
| | Parsing text format (WAT) | ❌ Not implemented |
41+
| | Execution | ✅ Implemented |
42+
| | Validation | 🚧 Partially implemented |
43+
| WebAssembly Proposal | [Reference types](https://github.com/WebAssembly/reference-types/blob/master/proposals/reference-types/Overview.md) | ✅ Implemented |
44+
| | [Bulk memory operations](https://github.com/WebAssembly/bulk-memory-operations/blob/master/proposals/bulk-memory-operations/Overview.md) | ✅ Implemented |
45+
| | [Mutable globals](https://github.com/WebAssembly/mutable-global/blob/master/proposals/mutable-global/Overview.md) | ✅ Implemented |
46+
| | [Sign-extension operators](https://github.com/WebAssembly/spec/blob/master/proposals/sign-extension-ops/Overview.md) | ✅ Implemented |
47+
| | [Non-trapping float-to-int conversions](https://github.com/WebAssembly/nontrapping-float-to-int-conversions/blob/main/proposals/nontrapping-float-to-int-conversion/Overview.md) | ✅ Implemented |
48+
| WASI | WASI Preview 1 | ✅ Implemented |
49+
2650

2751
## Testing
2852

@@ -41,3 +65,8 @@ $ python3 -m pip install -r ./Vendor/wasi-testsuite/test-runner/requirements.txt
4165
# Run WASI spec tests
4266
$ make wasitest
4367
```
68+
69+
70+
## Acknowledgement
71+
72+
This project is originally developed by [@akkyie](https://github.com/akkyie), and now maintained by the community.

0 commit comments

Comments
 (0)