dnrops
/
carton
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add `carton`/SwiftWasm/JSKit compat matrix to `README.md` (#332) 

This should make it easier for people to use older versions if they'd like to.
This commit is contained in:
Max Desiatov 2022-05-11 15:36:47 +01:00 committed by GitHub
parent 505a9b81a2
commit fd11ff0140
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -48,6 +48,24 @@ that completes successfully, run `swift build -c release`, the `carton` binary w
the `.build/release` directory after that. Unfortunately, other Linux distributions are currently
not supported.
### Version compatibility
`carton` embeds runtime parts of [the JavaScriptKit library](https://github.com/swiftwasm/JavaScriptKit),
which allows Swift and JavaScript code to interoperate in Node.js and browser environments. Because
of how JavaScriptKit runtime is currently embedded, older versions of JavaScriptKit may be incompatible
with new versions of `carton` and vice versa. [In the future](https://github.com/swiftwasm/carton/issues/155),
this incompatibility between different versions of `carton` and JavaScriptKit will be resolved. Similarly,
older versions of SwiftWasm may be incompatible with newer `carton`. You can follow the compatibility matrix
if you need to use older verions:
| `carton` version | SwiftWasm version | JavaScriptKit version | Tokamak version |
| ---------------- | ----------------- | --------------------- | --------------- |
| 0.14 | 5.6 | 0.14 | 0.10 |
| 0.13 | 5.5 | 0.13 | 0.9.1 |
| 0.12.2 | 5.5 | 0.12 | 0.9.1 |
| 0.12.0 | 5.5 | 0.11 | 0.9.0 |
| 0.11.0 | 5.4 | 0.10.1 | 0.8.0 |
### Usage
The `carton init` command initializes a new SwiftWasm project for you (similarly to