From: Justin Wind <justin.wind+git@gmail.com>
Date: Sat, 9 Mar 2024 00:42:15 +0000 (-0800)
Subject: add README.md
X-Git-Tag: v1.1.2~1
X-Git-Url: https://git.squeep.com/?a=commitdiff_plain;h=cbb0261beae6aabbb5e1d6bb2e371a5246604588;p=squeep-totp

add README.md
---

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..98ceeb9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# @squeep/totp
+
+Simple helpers for dealing with One-Time Passwords.
+
+## API
+
+```javascript
+const { TOTP } = require('@squeep/totp');
+
+const key = await TOTP.createKey(); // defaults create a hex-encoded sha1 key
+
+const {
+  secret, // key encoded as base32
+  uri, // key and metadata encoded as an otpauth URI
+  svg, // otpauthg URI encoded as QR code
+} = TOTP.createKeySVG({ accountname: 'test@example.com', issuer: 'Squeep', }, key, 'hex');
+
+const totp = new TOTP({
+  key,
+  keyEncoding: 'hex',
+});
+
+const token = totp.generate(); // The current token for the key.
+```