Skip to content

Commit

Permalink
Merge pull request #3 from sjrd/update-readme
Browse files Browse the repository at this point in the history
Fix #2: Make the readme a bit clearer.
  • Loading branch information
sjrd authored Apr 18, 2023
2 parents 8d03edd + a1f05a4 commit 2f94cf3
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ A [Vite](https://vitejs.dev/) plugin for [Scala.js](https://www.scala-js.org/).
## Usage

We assume that you have an existing Vite and Scala.js sbt project.
If not, [follow the accompanying tutorial](https://github.com/scala-js/scala-js-website/pull/590).
If not, [follow the accompanying tutorial](https://www.scala-js.org/doc/tutorial/scalajs-vite.html).

Install the plugin as a development dependency:

Expand Down Expand Up @@ -44,6 +44,13 @@ scalaJSLinkerConfig ~= {
},
```

In development mode, use two terminals in parallel:

* One with `$ npm run dev`.
* One with `$ sbt '~fastLinkJS'` (or a more precise version such as `$ sbt '~theJSProject/fastLinkJS`).

For the production build, `$ npm run build` is enough.

## Configuration

The plugin supports the following configuration options:
Expand Down

0 comments on commit 2f94cf3

Please sign in to comment.