Skip to content

Update readme #283

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Feb 24, 2025
Merged

Update readme #283

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4263c1c
update readme
sakrist Feb 23, 2025
0809333
update examples
sakrist Feb 23, 2025
f9d3ff8
Update compatibility CI
kateinoigakukun Feb 24, 2025
b4758bb
Use --static-swift-stdlib to use Foundation
kateinoigakukun Feb 24, 2025
1738361
Skip Swift 6 concurrency restrictions for now
kateinoigakukun Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Examples/Basic/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// swift-tools-version:5.10
// swift-tools-version:6.0

import PackageDescription

Expand Down
5 changes: 3 additions & 2 deletions Examples/Embedded/Package.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// swift-tools-version:5.10
// swift-tools-version:6.0

import PackageDescription

Expand Down Expand Up @@ -32,5 +32,6 @@ let package = Package(
])
]
)
]
],
swiftLanguageModes: [.v5]
)
2 changes: 1 addition & 1 deletion Examples/Embedded/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Embedded example

Requires a recent DEVELOPMENT-SNAPSHOT toolchain. (tested with swift-DEVELOPMENT-SNAPSHOT-2024-09-25-a)
Requires a recent DEVELOPMENT-SNAPSHOT toolchain. (tested with swift-6.1-DEVELOPMENT-SNAPSHOT-2025-02-21-a)

```sh
$ ./build.sh
Expand Down
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,12 +178,14 @@ Not all of these versions are tested on regular basis though, compatibility repo

## Usage in a browser application

The easiest way to get started with JavaScriptKit in your browser app is with [the `carton`
The easiest is to start with [Examples](/Examples) which has JavaScript glue runtime.

Second option is to get started with JavaScriptKit in your browser app is with [the `carton`
bundler](https://carton.dev). Add carton to your swift package dependencies:

```diff
dependencies: [
+ .package(url: "https://github.com/swiftwasm/carton", from: "1.0.0"),
+ .package(url: "https://github.com/swiftwasm/carton", from: "1.1.3"),
],
```

Expand Down Expand Up @@ -253,10 +255,6 @@ within it. You'll see `Hello, world!` output in the console. You can edit the ap
your favorite editor and save it, `carton` will immediately rebuild the app and reload all
browser tabs that have the app open.

You can also build your project with webpack.js and a manually installed SwiftWasm toolchain. Please
see the following sections and the [Example](https://github.com/swiftwasm/JavaScriptKit/tree/main/Example)
directory for more information in this more advanced use case.

## Sponsoring

[Become a gold or platinum sponsor](https://github.com/sponsors/swiftwasm/) and contact maintainers to add your logo on our README on Github with a link to your site.
Expand Down
Loading