Add notes to doc comments.
This commit is contained in:
parent
4b486b5aa6
commit
9888507d16
|
@ -1,5 +1,11 @@
|
|||
//! This library permits the creation of 2FA authentification tokens per TOTP, the verification of said tokens, with configurable time skew, validity time of each token, algorithm and number of digits! Default features are kept as low-dependency as possible to ensure small binaries and short compilation time
|
||||
//!
|
||||
//! Be aware that some authenticator apps will accept the `SHA256`
|
||||
//! and `SHA512` algorithms but silently fallback to `SHA1` which will
|
||||
//! make the `check()` function fail due to mismatched algorithms.
|
||||
//!
|
||||
//! Use the `SHA1` algorithm to avoid this problem.
|
||||
//!
|
||||
//! # Examples
|
||||
//!
|
||||
//! ```rust
|
||||
|
|
Loading…
Reference in New Issue