Merge pull request #411 from cquiroz/docs-update

Documentation updates and fix for #257

Author: cquiroz

README.md

@@ -1,19 +1,17 @@
 
 ## Scala Java-Time
 
-[![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)
 ![build](https://github.com/cquiroz/scala-java-time/workflows/build/badge.svg)
 [![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)
 [![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.0.0.svg)](https://www.scala-js.org/)
-[![Scala.js](http://scala-js.org/assets/badges/scalajs-0.6.8.svg)](http://scala-js.org)
 
 This project provides an implementation of the `java.time` package, a date and time library that was added in Java 8.
 The implementation is based on the original BSD-licensed reference implementation (before it was contributed to OpenJDK).
 
 #### Usage
 
 The *scala-java-time* library is currently available for Scala (JVM, version 8 and later) and Scala.js (JavaScript).
-Scala 2.11, Scala 2.12, Scala 2.13 and Scala 3.0.0-RC2/RC3 are supported.
+Scala 2.11, Scala 2.12, Scala 2.13 and Scala 3.0.0 are supported.
 
 To get started with SBT, add one (or both) of these dependencies:
 

docs/src/main/tut/index.md

@@ -8,7 +8,6 @@ section: "home"
 
 ![build](https://github.com/cquiroz/scala-java-time/workflows/build/badge.svg)
 [![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)
-[![Scala.js](https://www.scala-js.org/assets/badges/scalajs-0.6.29.svg)](https://www.scala-js.org/)
 [![Scala.js](https://www.scala-js.org/assets/badges/scalajs-1.0.0.svg)](https://www.scala-js.org/)
 
 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.
 
 To get started with SBT, add one of these dependencies:
 
-* `libraryDependencies += "io.github.cquiroz" %% "scala-java-time" % "2.0.0"` (for Scala)
-* `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)
+* `libraryDependencies += "io.github.cquiroz" %% "scala-java-time" % "2.4.0"` (for Scala)
+* `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)
 
 To get the latest snapshots add the repo
 
@@ -71,10 +70,15 @@ resolvers +=
 
 and either:
 
-* `libraryDependencies += "io.github.cquiroz" %% "scala-java-time" % "2.0.1-SNAPSHOT"` (for Scala)
-* `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)
+* `libraryDependencies += "io.github.cquiroz" %% "scala-java-time" % "2.4.1-SNAPSHOT"` (for Scala)
+* `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)
 
 ### Time zones
+The library will try to guess the default timezone but it is not possible to ensure the detection will work in all cases.
+It is highly recommended you set a default timezone explicitly. e.g.
+```
+TimeZone.setDefault(...)
+```
 
 #### No timezones
 
@@ -87,7 +91,7 @@ Example: `LocalDateTime.now(ZoneId.of("UTC"))`
 The timezone for js is provided in a separate bundle which contains all time zones available from
 [IANA Time Zone Database](https://www.iana.org/time-zones). To use them you need to add the following dependency
 
-* `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)
+* `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)
 
 Note that the db is fairly large and due to the characteristics of the API it's not very ammenable to optimization
 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:
 * Add `sbt-tzdb` to your list of plugins (Note you need sbt 1.x)
 
 ```scala
-addSbtPlugin("io.github.cquiroz" % "sbt-tzdb" % "1.0.0")
+addSbtPlugin("io.github.cquiroz" % "sbt-tzdb" % "4.0.0")
 ```
 
 * Enable the plugin for your `Scala.js` project: