-
Notifications
You must be signed in to change notification settings - Fork 19
README.md: Clarify Swift version and SwiftPM instructions #203
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 3 commits
af5c3f5
396809f
7626cd8
3cd502d
f7eaf44
5e2b557
110d02f
5738528
4f9f581
8960b5f
c24b8c3
e2559ec
9ebda11
3c68527
5542e3c
d8c4da5
f8b9c82
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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: | ||
| You can use WasmKit 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 <your-package-target-name> --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")), | ||
|
Comment on lines
31
to
40
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you add a release workflow document or an automation to bump up those version strings (in README.md and Sources/CLI/CLI.swift) since I am very sure I'll forget updating them 😅
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm adding automation for that in #220. |
||
| ], | ||
| // ...other package configuration | ||
| targets: [ | ||
| // ...other targets | ||
| .target( | ||
| name: "<your-package-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, | ||
MaxDesiatov marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 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+ | ||
MaxDesiatov marked this conversation as resolved.
Show resolved
Hide resolved
MaxDesiatov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - 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 | ||
|
|
||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.