minor doc update
authorJustin Wind <justin.wind+git@gmail.com>
Sun, 10 Mar 2024 19:03:14 +0000 (12:03 -0700)
committerJustin Wind <justin.wind+git@gmail.com>
Sun, 10 Mar 2024 19:03:32 +0000 (12:03 -0700)
README.md

index 98ceeb90026e61d1624ab1a02f95b1aaafff9abf..6971d2d7216ad57afc08e197dacbfff3fa950c30 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # @squeep/totp
 
-Simple helpers for dealing with One-Time Passwords.
+Simple helper classes for dealing with One-Time Passwords of varying flavor.
 
 ## API
 
@@ -21,4 +21,6 @@ const totp = new TOTP({
 });
 
 const token = totp.generate(); // The current token for the key.
+
+const isValid = totp.validate('123456');
 ```