Skip to content

Commit 5b56b12

Browse files
Update README.md
1 parent 842a3a4 commit 5b56b12

File tree

1 file changed

+29
-1
lines changed

1 file changed

+29
-1
lines changed

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
## Usage
88

9+
The best way to learn how to use WasmKit is to look at the [Examples](./Examples) directory.
10+
911
### Command Line Tool
1012

1113
WasmKit provides a command line tool to run WebAssembly binaries compliant with WASI.
@@ -31,6 +33,25 @@ dependencies: [
3133

3234
You can find API documentation on the [Swift Package Index](https://swiftpackageindex.com/swiftwasm/WasmKit/main/documentation/wasmkit).
3335

36+
## Features
37+
38+
- Minimal dependencies
39+
- The core runtime engine depends only on [swift-system](https://github.com/apple/swift-system).
40+
- No Foundation dependency
41+
- Compact and embeddable
42+
- Debug build complete in 5 seconds[^1]
43+
- Batteries included
44+
- WASI support, WAT parser, etc.
45+
46+
47+
## Supported Platforms
48+
49+
WasmKit engine works on all major platforms supported by Swift. It is continuously tested on macOS, Ubuntu, and Windows,
50+
and should work on the following platforms:
51+
52+
- macOS 10.13+, iOS 12.0+, tvOS 12.0+, watchOS 6.0+
53+
- Ubuntu 20.04+
54+
- Windows 10+
3455

3556
## Implementation Status
3657

@@ -50,6 +71,10 @@ You can find API documentation on the [Swift Package Index](https://swiftpackage
5071
| WASI | WASI Preview 1 | ✅ Implemented |
5172

5273

74+
## Minimum Supported Swift Version
75+
76+
The minimum supported Swift version of WasmKit is 5.8, which is the version used to bootstrap the Swift toolchain in [ci.swift.org](https://ci.swift.org/).
77+
5378
## Testing
5479

5580
To run the WasmKit test suite, you need to checkout the test suite repositories first.
@@ -63,4 +88,7 @@ $ swift test
6388

6489
## Acknowledgement
6590

66-
This project is originally developed by [@akkyie](https://github.com/akkyie), and now maintained by the community.
91+
This project was originally developed by [@akkyie](https://github.com/akkyie), and is now maintained by the community.
92+
93+
94+
[^1]: On a 2020 Mac mini (M1, 16GB RAM) with Swift 5.10. Measured by `swift package resolve && swift package clean && time swift build --product PrintAdd`.

0 commit comments

Comments
 (0)