Skip to content
This repository was archived by the owner on Jul 30, 2024. It is now read-only.

Commit e2ebe3a

Browse files
author
exoego
committed
Update how to use and support matrix
1 parent d3a791f commit e2ebe3a

File tree

1 file changed

+21
-11
lines changed

1 file changed

+21
-11
lines changed

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,31 @@
11
This is a complete Scala.js facade for Node.js for Scala 2.12 and 2.13.
2-
A fork of https://github.com/scalajs-io/nodejs to sustain the project.
3-
4-
## Build Requirements
5-
6-
* [SBT 1.3.x] (http://www.scala-sbt.org/download.html)
7-
* JDK 8 or JDK 11
82

93
## Features
104

115
The Node.js integration is nearly complete (feature for feature), and should be more than sufficient for most web-based
126
and CLI applications.
137

8+
## How to use
9+
10+
Add below line to your SBT project.
11+
12+
```sbt
13+
libraryDependencies += "net.exoego" %%% "scala-js-nodejs-v8" % "0.8.0"
14+
```
15+
16+
## Support matrix
17+
18+
| | ScalaJS 0.6.28+ | ScalaJS 1.x |
19+
|---|:---:|:---:|
20+
| Scala 2.13 | :heavy_check_mark: | :construction: |
21+
| Scala 2.12 | :heavy_check_mark: | :construction: |
22+
| Scala 2.11 | - | - |
23+
| Scala 2.10 | - | - |
24+
25+
* :heavy_check_mark:: Supported
26+
* :construction:: Not supported but planned
27+
28+
1429
### Supported Modules
1530

1631
The following core Node.js modules (v8.7.0) have been implemented:
@@ -42,11 +57,6 @@ The following core Node.js modules (v8.7.0) have been implemented:
4257
| vm | The vm module provides APIs for compiling and running code within V8 Virtual Machine contexts.|
4358
| zlib | This provides bindings to Gzip/Gunzip, Deflate/Inflate, and DeflateRaw/InflateRaw classes. |
4459

45-
## How to use
46-
47-
**TBD**: Not published yet.
48-
49-
See https://github.com/exoego/scala-js-nodejs/issues/3
5060

5161

5262
## Example of code

0 commit comments

Comments
 (0)