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

Commit

Permalink
Update how to use and support matrix
Browse files Browse the repository at this point in the history
  • Loading branch information
exoego committed Jun 20, 2019
1 parent d3a791f commit 6a5603c
Showing 1 changed file with 20 additions and 11 deletions.
31 changes: 20 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
This is a complete Scala.js facade for Node.js for Scala 2.12 and 2.13.
A fork of https://github.com/scalajs-io/nodejs to sustain the project.

## Build Requirements

* [SBT 1.3.x] (http://www.scala-sbt.org/download.html)
* JDK 8 or JDK 11

## Features

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

## How to use

Add below line to your SBT project.

```sbt
libraryDependencies += "net.exoego" %%% "scala-js-nodejs-v8" % "0.8.0"
```

## Support matrix

| | ScalaJS 0.6.28+ | ScalaJS 1.x |
|------------|:------------------:|:--------------:|
| Scala 2.13 | :heavy_check_mark: | :construction: |
| Scala 2.12 | :heavy_check_mark: | :construction: |
| Scala 2.11 | N/A | N/A |
| Scala 2.10 | N/A | N/A |

- :heavy_check_mark: Supported
- :construction: Not supported but planned

### Supported Modules

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

## How to use

**TBD**: Not published yet.

See https://github.com/exoego/scala-js-nodejs/issues/3


## Example of code
Expand Down

0 comments on commit 6a5603c

Please sign in to comment.