Skip to content

Commit d01ec5d

Browse files
committed
Complete readme.
1 parent a360bd5 commit d01ec5d

File tree

1 file changed

+37
-2
lines changed

1 file changed

+37
-2
lines changed

README.md

Lines changed: 37 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
1-
# scala-js-java-time
2-
Scala.js implementation for java.time in JDK8
1+
# scalajs-java-time
2+
3+
[![Build Status](https://travis-ci.org/scala-js/scala-js-java-time.svg?branch=master)](https://travis-ci.org/scala-js/scala-js-java-time)
4+
[![Scala.js](https://www.scala-js.org/assets/badges/scalajs-0.6.6.svg)](https://www.scala-js.org/)
5+
6+
`scalajs-java-time` is a BSD-licensed reimplementation of the `java.time` API
7+
of JDK8 for Scala.js. It enables this API in Scala.js projects.
8+
9+
## Usage
10+
11+
Simply add the following line to your sbt settings:
12+
13+
```scala
14+
libraryDependencies += "org.scala-js" %%% "scalajs-java-time" % "0.0.1-SNAPSHOT"
15+
```
16+
17+
If you have a `crossProject`, the setting must be used only in the JS part:
18+
19+
```scala
20+
lazy val myCross = crossProject.
21+
...
22+
jsSettings.(
23+
libraryDependencies += "org.scala-js" %%% "scalajs-java-time" % "0.0.1-SNAPSHOT"
24+
)
25+
```
26+
27+
**Requirement**: you must use a host JDK8 to *build* your project, i.e., to
28+
launch sbt. `scalajs-java-time` does not work on earlier JDKs.
29+
30+
## License
31+
32+
`scalajs-java-time` is distributed under the
33+
[BSD 3-Clause license](./LICENSE.txt).
34+
35+
## Contributing
36+
37+
Follow the [contributing guide](./CONTRIBUTING.md).

0 commit comments

Comments
 (0)