Port README updates to the Javadoc overview.

jchambers · jchambers · commit df28bfab5be1 · 2020-10-24T13:28:17.000-04:00
diff --git a/src/main/java/overview.html b/src/main/java/overview.html
@@ -26,7 +26,7 @@
     </head>
     
     <body>
-        <p>java-otp is a library for generating one-time passwords using the <a href="https://tools.ietf.org/html/rfc4226">HOTP (RFC 4226)</a> or <a href="https://tools.ietf.org/html/rfc6238">TOTP (RFC 6238)</a> passwords in Java.</p>
+        <p>java-otp is a Java library for generating <a href="https://tools.ietf.org/html/rfc4226">HOTP (RFC 4226)</a> or <a href="https://tools.ietf.org/html/rfc6238">TOTP (RFC 6238)</a> one-time passwords.</p>
 
         <h1>Usage</h1>
 
@@ -46,21 +46,14 @@ <h1>Usage</h1>
 
         <p>Armed with a secret key, we can deterministically generate one-time passwords for any timestamp:</p>
 
-        <pre>final Date now = new Date();
-final Date later = new Date(now.getTime() + TimeUnit.SECONDS.toMillis(30));
+        <pre>final Instant now = Instant.now();
+final Instant later = now.plus(totp.getTimeStep());
 
-System.out.format("Current password: %06d\n", totp.generateOneTimePassword(secretKey, now));
-System.out.format("Future password:  %06d\n", totp.generateOneTimePassword(secretKey, later));</pre>
+System.out.format("Current password: %06d\n", totp.generateOneTimePassword(key, now));
+System.out.format("Future password:  %06d\n", totp.generateOneTimePassword(key, later));</pre>
 
         <h1>License and copyright</h1>
 
-        <p>Copyright (c) 2016 Jon Chambers</p>
-
-        <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p>
-
-        <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p>
-
-        <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p>
-        
+        <p>java-otp is copyright (c) 2016 Jon Chambers and available under the <a href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
     </body>
 </html>
