Skip to content

Commit

Permalink
Update README.md:
Browse files Browse the repository at this point in the history
* Remove line saying that play-scalajs-scripts has been renamed to scalajs-scripts.
* Add warning for Play users that they should use scalajs-scripts v1.0.0 until Play upgrades to Twirl v1.3.0.
  • Loading branch information
vmunier committed Nov 21, 2016
1 parent 398c4d0 commit 32e58b5
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,19 @@

Small library which provides a few Twirl templates to link Scala.js output scripts into a HTML page.

*Since the Play dependency was dropped, the project has been renamed from `play-scalajs-scripts` to `scalajs-scripts`.*

## Setup

Add the library to `build.sbt`:
```
libraryDependencies += "com.vmunier" %% "scalajs-scripts" % "1.1.0"
```

For Play framework users, use the `1.0.0` version:
```
libraryDependencies += "com.vmunier" %% "scalajs-scripts" % "1.0.0"
```
The reason is that the Play framework still uses Twirl `v1.2.0` whereas scalajs-scripts `v1.1.0` uses Twirl `v1.3.0`, which contains breaking changes.

## Available Twirl Templates

There are four Twirl templates: `scripts.scala.html`, `selectScript.scala.html`, `jsdeps.scala.html`, `launcher.scala.html`.
Expand Down

0 comments on commit 32e58b5

Please sign in to comment.