diff --git a/README.md b/README.md index a8a6fce..4e0108b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # TOTP Generator -*A time-based one-time password (TOTP) generator implementation in JavaScript* + +A time-based one-time password (TOTP) generator implementation in JavaScript. [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com) [![GitHub Release](https://img.shields.io/github/v/release/xyr11/totp-generator)](https://github.com/xyr11/totp-generator/releases) @@ -8,13 +9,15 @@ This project is a modified version of [russau's](https://jsfiddle.net/user/russau/fiddles/) [TOTP One-time password JSFiddle](https://jsfiddle.net/russau/ch8PK/) which fully works in the browser. It uses [QRious](https://github.com/neocotic/qrious) for QR code encoding and [jsSHA](https://github.com/Caligatio/jsSHA) for SHA-1 generation ([sha1.js v3.3.1](https://github.com/Caligatio/jsSHA/blob/8eac02756df4a86831bfb3f6a7a113fd36007aac/dist/sha1.js)). ## Usage + See it live: -You can also download the latest version from the [Releases page](https://github.com/xyr11/totp-generator/releases) and open `index.html`. +You can also download [the latest release](https://github.com/xyr11/totp-generator/releases) and open `index.html`. ### Query Strings You can add query strings to automatically fill in the fields. They are based on the [OTP Key URI format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format). The fields are: + Query field | Description | Example value --- | --- | --- label | String used to identify the account a key is associated with | `GitHub: email@site.com` @@ -35,6 +38,5 @@ padding | Padding for the QR code (pixels) | None (auto) size | Size of the QR code (pixels) | `200` ## License -The original code from JSFiddle doesn't have a license. QRious is licensed under the [GPL v3 License](https://www.gnu.org/licenses/gpl-3.0.en.html) and jsSHA is licensedd under the [3-Clause BSD license](https://github.com/Caligatio/jsSHA/blob/master/LICENSE). -This project is licensed under the [MIT License](https://github.com/xyr11/totp-generator/blob/main/LICENSE). +This project is licensed under the [MIT License](https://github.com/xyr11/totp-generator/blob/main/LICENSE). The original code from JSFiddle doesn't have a license. QRious is licensed under the [GPL v3 License](https://www.gnu.org/licenses/gpl-3.0.en.html) and jsSHA is licensed under the [3-Clause BSD license](https://github.com/Caligatio/jsSHA/blob/master/LICENSE). diff --git a/index.html b/index.html index d37d691..f1c8624 100644 --- a/index.html +++ b/index.html @@ -353,7 +353,7 @@

QR Code

elem('form').scrollIntoView() } -// If ther are query fields or cached text on the page, read them and update the OTP +// If there are query fields or cached text on the page, read them and update the OTP fetchOTP(); // Auto update OTP every 30 seconds