Skip to content

Commit e5e1239

Browse files
committed
Fix #26: Clarify the status of this repo and the alternatives.
1 parent 6205d4f commit e5e1239

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,26 @@
1-
# scalajs-java-time
1+
# scalajs-java-time (deprecated)
22

33
[![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)
44
[![Scala.js](https://www.scala-js.org/assets/badges/scalajs-0.6.29.svg)](https://www.scala-js.org/)
55
[![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.0.0.svg)](https://www.scala-js.org)
66

7-
`scalajs-java-time` is a BSD-licensed reimplementation of the `java.time` API
8-
of JDK8 for Scala.js. It enables this API in Scala.js projects.
7+
`scalajs-java-time` is a BSD-licensed partial reimplementation of the `java.time` API of JDK8 for Scala.js.
8+
9+
## This project is incomplete and has stalled
10+
11+
This project is very incomplete and efforts to expand it have stalled.
12+
Consider using one of the following alternatives instead:
13+
14+
* [scala-java-time](https://github.com/cquiroz/scala-java-time) (recommended): like this project, but better
15+
* [scalajs-jsjoda](https://github.com/zoepepper/scalajs-jsjoda): implementation of `java.time` on top of the JavaScript library [js-joda](https://github.com/js-joda/js-joda)
16+
17+
Issues will *not* be worked on.
18+
19+
Pull requests *may* be reviewed and merged.
920

1021
## Usage
1122

12-
Simply add the following line to your sbt settings:
23+
Add the following line to your sbt settings:
1324

1425
```scala
1526
libraryDependencies += "org.scala-js" %%% "scalajs-java-time" % "1.0.0"
@@ -28,14 +39,13 @@ lazy val myCross = crossProject
2839
**Requirement**: you must use a host JDK8 to *build* your project, i.e., to
2940
launch sbt. `scalajs-java-time` does not work on earlier JDKs.
3041

31-
## Work in Progress / linking errors
42+
## Linking errors
3243

33-
This library is a work in progress.
34-
There are still many classes and methods that have not been implemented yet.
44+
This library is very incomplete.
45+
There are many classes and methods that have not been implemented yet.
3546
If you use any of those, you will get linking errors.
3647

37-
Feel free to [contribute](./CONTRIBUTING.md) to extend the set of supported
38-
classes and methods!
48+
Consider using on the alternatives mentioned above.
3949

4050
## License
4151

0 commit comments

Comments
 (0)