Skip to content

Commit e2adf2b

Browse files
authored
Merge pull request #40 from sjrd/add-javadoc-link
Add usage instructions and link to Scaladoc.
2 parents 0b975a3 + 37b15d2 commit e2adf2b

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

+16
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,19 @@ running [Node.js](https://nodejs.org/) with
77
This repository contains `scalajs-env-jsdom-nodejs` for Scala.js 1.x. In
88
Scala.js 0.6.x, the Node.js with jsdom environment is part of the core
99
distribution.
10+
11+
## Usage
12+
13+
Add the following line to `project/plugins.sbt`:
14+
15+
```scala
16+
libraryDependencies += "org.scala-js" %% "scalajs-env-jsdom-nodejs" % "1.0.0"
17+
```
18+
19+
and the following line to `build.sbt` (possibly in the `settings`/`jsSettings` of Scala.js projects):
20+
21+
```scala
22+
jsEnv := new org.scalajs.jsenv.jsdomnodejs.JSDOMNodeJSEnv()
23+
```
24+
25+
See [the Scaladoc](https://javadoc.io/doc/org.scala-js/scalajs-env-jsdom-nodejs_2.13/latest/org/scalajs/jsenv/jsdomnodejs/index.html) for other configuration options.

0 commit comments

Comments
 (0)