Skip to content

Commit 57281bc

Browse files
committed
Documentation updates and fix for #257
1 parent 0a3a265 commit 57281bc

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

README.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11

22
## Scala Java-Time
33

4-
[![Join the chat at https://gitter.im/scala-java-time/Lobby](https://badges.gitter.im/scala-java-time/Lobby.svg)](https://gitter.im/scala-java-time/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
54
![build](https://github.com/cquiroz/scala-java-time/workflows/build/badge.svg)
65
[![Maven Central](https://img.shields.io/maven-central/v/io.github.cquiroz/scala-java-time_2.11.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.cquiroz/scala-java-time_2.11)
76
[![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.0.0.svg)](https://www.scala-js.org/)
8-
[![Scala.js](http://scala-js.org/assets/badges/scalajs-0.6.8.svg)](http://scala-js.org)
97

108
This project provides an implementation of the `java.time` package, a date and time library that was added in Java 8.
119
The implementation is based on the original BSD-licensed reference implementation (before it was contributed to OpenJDK).
1210

1311
#### Usage
1412

1513
The *scala-java-time* library is currently available for Scala (JVM, version 8 and later) and Scala.js (JavaScript).
16-
Scala 2.11, Scala 2.12, Scala 2.13 and Scala 3.0.0-RC2/RC3 are supported.
14+
Scala 2.11, Scala 2.12, Scala 2.13 and Scala 3.0.0 are supported.
1715

1816
To get started with SBT, add one (or both) of these dependencies:
1917

docs/src/main/tut/index.md

+11-7
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ section: "home"
88

99
![build](https://github.com/cquiroz/scala-java-time/workflows/build/badge.svg)
1010
[![Maven Central](https://img.shields.io/maven-central/v/io.github.cquiroz/scala-java-time_2.13.svg)](https://maven-badges.herokuapp.com/maven-central/io.github.cquiroz/scala-java-time_2.13)
11-
[![Scala.js](https://www.scala-js.org/assets/badges/scalajs-0.6.29.svg)](https://www.scala-js.org/)
1211
[![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.0.0.svg)](https://www.scala-js.org/)
1312

1413
This project provides an implementation of the `java.time` package, a date and time library that was added in Java 8.
@@ -59,8 +58,8 @@ Scala 2.11, 2.12 and 2.13 are supported.
5958

6059
To get started with SBT, add one of these dependencies:
6160

62-
* `libraryDependencies += "io.github.cquiroz" %% "scala-java-time" % "2.0.0"` (for Scala)
63-
* `libraryDependencies += "io.github.cquiroz" %%% "scala-java-time" % "2.0.0"` (for Scala.js, [Scala.js plugin](http://www.scala-js.org/tutorial/basic/#sbt-setup) required)
61+
* `libraryDependencies += "io.github.cquiroz" %% "scala-java-time" % "2.4.0"` (for Scala)
62+
* `libraryDependencies += "io.github.cquiroz" %%% "scala-java-time" % "2.4.0"` (for Scala.js, [Scala.js plugin](http://www.scala-js.org/tutorial/basic/#sbt-setup) required)
6463

6564
To get the latest snapshots add the repo
6665

@@ -71,10 +70,15 @@ resolvers +=
7170

7271
and either:
7372

74-
* `libraryDependencies += "io.github.cquiroz" %% "scala-java-time" % "2.0.1-SNAPSHOT"` (for Scala)
75-
* `libraryDependencies += "io.github.cquiroz" %%% "scala-java-time" % "2.0.1-SNAPSHOT"` (for Scala.js, [Scala.js plugin](http://www.scala-js.org/tutorial/basic/#sbt-setup) required)
73+
* `libraryDependencies += "io.github.cquiroz" %% "scala-java-time" % "2.4.1-SNAPSHOT"` (for Scala)
74+
* `libraryDependencies += "io.github.cquiroz" %%% "scala-java-time" % "2.4.1-SNAPSHOT"` (for Scala.js, [Scala.js plugin](http://www.scala-js.org/tutorial/basic/#sbt-setup) required)
7675

7776
### Time zones
77+
The library will try to guess the default timezone but it is not possible to ensure the detection will work in all cases.
78+
It is highly recommended you set a default timezone explicitly. e.g.
79+
```
80+
TimeZone.setDefault(...)
81+
```
7882

7983
#### No timezones
8084

@@ -87,7 +91,7 @@ Example: `LocalDateTime.now(ZoneId.of("UTC"))`
8791
The timezone for js is provided in a separate bundle which contains all time zones available from
8892
[IANA Time Zone Database](https://www.iana.org/time-zones). To use them you need to add the following dependency
8993

90-
* `libraryDependencies += "io.github.cquiroz" %%% "scala-java-time-tzdb" % "2.0.0_2019c"` (for Scala.js, [Scala.js plugin](http://www.scala-js.org/tutorial/basic/#sbt-setup) required)
94+
* `libraryDependencies += "io.github.cquiroz" %%% "scala-java-time-tzdb" % "2.4.0_2019c"` (for Scala.js, [Scala.js plugin](http://www.scala-js.org/tutorial/basic/#sbt-setup) required)
9195

9296
Note that the db is fairly large and due to the characteristics of the API it's not very ammenable to optimization
9397
This database is published every now and then so it maybe old. For current version see the following section.
@@ -104,7 +108,7 @@ To do that you need to:
104108
* Add `sbt-tzdb` to your list of plugins (Note you need sbt 1.x)
105109

106110
```scala
107-
addSbtPlugin("io.github.cquiroz" % "sbt-tzdb" % "1.0.0")
111+
addSbtPlugin("io.github.cquiroz" % "sbt-tzdb" % "4.0.0")
108112
```
109113

110114
* Enable the plugin for your `Scala.js` project:

0 commit comments

Comments
 (0)