Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jodastephen committed May 13, 2014
1 parent 7f2087e commit 122cd33
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 15 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@

## ThreeTen backport project
JSR-310 provides a new date and time library for JDK 8.
This project is the backport to JDK 7.
JSR-310 provides a new date and time library for Java SE 8.
This project is the backport to Java SE 7.

The backport is NOT an implementation of JSR-310, as that would require
jumping through lots of unnecessary hoops.
Instead, this is a simple backport intended to allow users to quickly
use the JSR-310 API on JDK 7.
use the JSR-310 API on Java SE 7.
The backport should be referred to using the "ThreeTen" name.

Active development on JSR-310 is at [OpenJDK](http://openjdk.java.net/):
Expand All @@ -16,7 +16,7 @@ That repository used the same BSD 3-clause license as this repository.

Issues should be reported here at GitHub.
Pull requests and issues will only be considered so far as matching the behaviour
of the real JDK 8. Additional requested features will be rejected.
of the real Java SE 8. Additional requested features will be rejected.

#### Building
This project builds using maven.
Expand All @@ -30,12 +30,12 @@ Pull requests with later versions of the dat file will be accepted.

#### FAQs

1. What version of JDK 8 does this project map to?
This project currently maps to the M7 milestone.
1. What version of Java SE 8 does this project map to?
This project currently maps to the expected contents of release Java SE 8u20.

2. Will the backport be kept up to date?
There will be a release matching the final JDK 8 version.
There may or may not be further updates between now and then.
There are no plans for further releases.
However if bugs are found, or pull requests received then a release may occur.

3. Is this project derived from OpenJDK?
No. This project is derived from the Reference Implementation previously hosted on GitHub.
Expand Down
2 changes: 1 addition & 1 deletion RELEASE-NOTES.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
ThreeTen backport project release notes
=======================================

This release corresponds to the OpenJDK M7 milestone
This release of the backport corresponds to Java SE 8u20.
24 changes: 18 additions & 6 deletions src/site/xdoc/index.xml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@

<section name="ThreeTen Backport">
<p>
ThreeTen-Backport provides a backport of the JDK 8 date-time classes to JDK 7.
ThreeTen-Backport provides a backport of the Java SE 8 date-time classes to Java SE 7.
</p>
<p>
The backport is NOT an implementation of JSR-310, as that would require
jumping through lots of unnecessary hoops.
Instead, this is a simple backport intended to allow users to quickly
use the JSR-310 API on JDK 7.
use the JSR-310 API on Java SE 7.
The backport should be referred to using the "ThreeTen" name.
</p>
<p>
Expand All @@ -34,18 +34,30 @@ Various documentation is available:
<li>The <a href="https://github.com/ThreeTen/threetenbp">GitHub</a> source repository</li>
</ul>
</p>
<p>
It should be noted that the API matches that of Java SE 8 except where that is not viable.
Java SE 8 has default and static methods on interfaces which is simulated in the backport
by using an abstract class rather than an interface.
In addition, static query constants are used to simulate method references, for example
use <code>LocalDate.FROM</code> rather than <code>LocalDate::from</code>.
</p>
</section>


<section name="Releases">
<p>
There are no full releases yet!
Release 0.8.1 is the current development release intended for feedback.
The code is fully tested, but there may yet be bugs and the API may yet change.
There should be no great reason why it cannot be used in production if you can cope with future API change.
There should be no great reason why it cannot be used in production at this point.
</p>
<p>
The project runs on Java SE 7 and has no dependencies.
</p>
<p>
The project runs on JDK 8 and has no dependencies.
There are some known issues.
The Hijrah calendar system does not work.
Formatting and parsing often depends on data only available in Java SE 8.
Zone id and text parsing is significantly less powerful.
</p>
<p>
Available in <a href="http://search.maven.org/#artifactdetails|org.threeten|threetenbp|0.8.1|jar">Maven Central</a>.
Expand All @@ -62,7 +74,7 @@ To suggest enhancements or contribute, please <a href="https://github.com/ThreeT
Alternatively, use GitHub <a href="https://github.com/ThreeTen/threetenbp/issues">issues</a>.
</p>
<p>
Note that pull requests and issues will only be considered so far as matching the behaviour of JDK 8.
Note that pull requests and issues will only be considered so far as matching the behaviour of Java SE 8.
Additional requested features will be rejected.
</p>
<p>
Expand Down

0 comments on commit 122cd33

Please sign in to comment.