From ba531f8625f48557b396c4c570b8eccea7d8149c Mon Sep 17 00:00:00 2001 From: Marcel Kliemannel Date: Mon, 15 Apr 2024 19:49:37 +0200 Subject: [PATCH] chore: Minor README.md improvement --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fb60d6e..cc7f12c 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,11 @@ The implementations are based on the RFCs: * [RFC 4226: "RFC 4226 HOTP: An HMAC-Based One-Time Password Algorithm"](https://www.ietf.org/rfc/rfc4226.txt) * [RFC 6238: "TOTP: Time-Based One-Time Password Algorithm"](https://tools.ietf.org/html/rfc6238) -> ℹ️ In this repository, changes don't happen that often and the library gets updated very rarely. However, this is **not** an abandoned project. Since the code is relatively simple, follows the specifications of the two RFCs, and has good test coverage, there is hardly any need to change anything. +> [!NOTE] +> This repository will not see any changes, and the library will be updated very infrequently. However, this should not be seen as an abandonment of the project. Since the code is relatively simple, follows the specifications of the relevant RFCs, and has good test coverage, there is little need to change anything. -> ℹ️ If you want to use this library in conjunction with the Google Authenticator app (or similar apps), please carefully read the chapter [Google Authenticator](#google-authenticator), especially the remarks regarding the Base32-encoded secret and the plain text secret length limitation. Most problems arise from not following the two remarks correctly. +> [!TIP] +> If you want to use this library in conjunction with the Google Authenticator app (or similar apps), please carefully read the chapter [Google Authenticator](#google-authenticator), especially the remarks regarding the Base32-encoded secret and the plain text secret length limitation. Most problems arise from not following the two remarks correctly. > > This library gets used by hundreds of active users every day to generate Google Authenticator codes for several years now, so I am very confident that the code correctly generates codes. @@ -268,7 +270,7 @@ Note that according to the specification, the Base32 padding character `=` will ## Licensing -Copyright (c) 2023 Marcel Kliemannel +Copyright (c) 2024 Marcel Kliemannel Licensed under the **Apache License, Version 2.0** (the "License"); you may not use this file except in compliance with the License.