diff --git a/README.md b/README.md index 5768d2ae..c79ba7b7 100644 --- a/README.md +++ b/README.md @@ -23,12 +23,30 @@ Hello, World! #### Swift Package Manager -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: +To use WasmKit in your package, add it as a [Swift Package Manager](https://www.swift.org/documentation/package-manager/) dependency. + +Run the following commands to add the dependency: + +``` +swift package add-dependency https://github.com/swiftwasm/WasmKit --up-to-next-minor-from 0.1.6 +swift package add-target-dependency WasmKit --package WasmKit +``` + +You can also add the following snippet manually to your `Package.swift` file: ```swift dependencies: [ - .package(url: "https://github.com/swiftwasm/WasmKit.git", from: "0.1.0"), + // ...other dependencies + .package(url: "https://github.com/swiftwasm/WasmKit.git", .upToNextMinor(from: "0.1.6")), ], +// ...other package configuration +targets: [ + // ...other targets + .target( + name: "", + dependencies: [.product(name: "WasmKit", package: "WasmKit")], + ) +] ``` You can find API documentation on the [Swift Package Index](https://swiftpackageindex.com/swiftwasm/WasmKit/main/documentation/wasmkit). @@ -47,11 +65,11 @@ You can find API documentation on the [Swift Package Index](https://swiftpackage ## Supported Platforms -WasmKit engine works on all major platforms supported by Swift. It is continuously tested on macOS, Ubuntu, and Windows, +WasmKit engine works on all major platforms supported by Swift. It is continuously tested on macOS, Ubuntu, Amazon Linux 2, and Windows, and should work on the following platforms: - macOS 10.13+, iOS 12.0+, tvOS 12.0+, watchOS 6.0+ -- Ubuntu 20.04+ +- Amazon Linux 2, Debian 12, Ubuntu 22.04+, Fedora 39+ - Windows 10+ ## Implementation Status @@ -70,12 +88,12 @@ and should work on the following platforms: | | [Memory64](https://github.com/WebAssembly/memory64/blob/main/proposals/memory64/Overview.md) | ✅ Implemented | | | [Tail call](https://github.com/WebAssembly/tail-call/blob/master/proposals/tail-call/Overview.md) | ✅ Implemented | | | [Threads and atomics](https://github.com/WebAssembly/threads/blob/master/proposals/threads/Overview.md) | 🚧 Parser implemented | -| WASI | WASI Preview 1 | ✅ Implemented | +| WASI | WASI Preview 1 | 🚧 [Majority of syscalls implemented](https://github.com/swiftwasm/WasmKit/blob/d9b56a7b3f979a72682c0d37f6cc71b3493dae65/Tests/WASITests/IntegrationTests.swift#L31) | ## Minimum Supported Swift Version -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/). +The minimum supported version is Swift 6.0, which is the version used to bootstrap the Swift toolchain in [ci.swift.org](https://ci.swift.org/). ## Testing