Skip to content

Update README file to include new carton 1.0 implementation. #243

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 6 commits into from
May 3, 2024
Merged

Update README file to include new carton 1.0 implementation. #243

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8d6ecd0
Update README file to include new carton 1.0 implementation.
kuhl May 1, 2024
395a09d
Update README to include the updated Carton 1.0 dependency to the Jav…
kuhl May 1, 2024
a837927
Collapsible Legacy Section.
kuhl May 1, 2024
3d89a4d
Fix Readme Package description for carton usage.
kuhl May 1, 2024
a386fa0
Add horizontal rules to Legacy block for readability.
kuhl May 1, 2024
d36cf5b
Added instruction to run carton from swift in README.
kuhl May 2, 2024
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
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,8 @@ a few additional steps though (you can skip these steps if your app depends on
name: "JavaScriptKitExample",
dependencies: [
"JavaScriptKit",
.product(name: "JavaScriptEventLoop", package: "JavaScriptKit")
.package(url: "https://github.com/swiftwasm/carton", from: "1.0.0"),
.product(name: "JavaScriptEventLoop", package: "JavaScriptKit"),
]
)
```
Expand Down Expand Up @@ -179,7 +180,20 @@ 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`
bundler](https://carton.dev).
bundler](https://carton.dev). Add carton to your swift package dependencies:

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

> [!WARNING]
> - If you already use `carton` before 0.x.x versions via Homebrew, you can remove it with `brew uninstall carton` and install the new version as a SwiftPM dependency.
> - Also please remove the old `.build` directory before using the new `carton`

## Legacy Installation


As a part of these steps
you'll install `carton` via [Homebrew](https://brew.sh/) on macOS (you can also use the
Expand Down