Update README.md

README.md

@@ -1,30 +1,21 @@
-# React + TypeScript + Vite
+# TOTP
 
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
+This is a code generator for the Time-based One Time Password (TOTP) algorithm.
+It's intended for developers of web applications with TOTP support to quickly
+generate codes for testing purposes. It's not meant to be a general purpose
+authenticator app.
 
-Currently, two official plugins are available:
+What this tool can do:
 
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
+* Quickly generate TOTP codes;
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+* View codes for past and future time windows; and
+* Fiddle with various TOTP parameters.
 
-## Expanding the ESLint configuration
+What this tool can't do:
 
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+* Store your TOTP secrets (you can try bookmarking the URL with the secret, but
+  it's not secure);
+* Act as your general purpose authenticator app; and
+* Scan TOTP QR codes.
 
-- Configure the top-level `parserOptions` property like this:
+![screenshot of the app](screenshot.png)
-
-```js
-export default {
-  // other rules...
-  parserOptions: {
-    ecmaVersion: 'latest',
-    sourceType: 'module',
-    project: ['./tsconfig.json', './tsconfig.node.json'],
-    tsconfigRootDir: __dirname,
-  },
-}
-```
-
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list

index.html

@@ -50,14 +50,14 @@
       <h3 class="card-title" id="what-is-this">What is this?</h3>
       <p class="card-text">This is a code generator for the <a
         href="https://en.wikipedia.org/wiki/Time-based_One_Time_Password"><em>Time-based One Time Password</em>
-        (TOTP)</a> algorthm. It's intended for developers of web applications with TOTP support to quickly generate
+        (TOTP)</a> algorithm. It's intended for developers of web applications with TOTP support to quickly generate
-        codes for testing purposes. It's <strong>not</strong> a general purpose authenticator app.
+        codes for testing purposes. It's <strong>not</strong> meant to be a general purpose authenticator app.
       </p>
       <p class="card-text">What this tool can do:</p>
       <ul class="card-text">
         <li>Quickly generate TOTP codes;</li>
-        <li>View codes for past and future time-windows; and</li>
+        <li>View codes for past and future time windows; and</li>
-        <li>Fiddle with various TOTP paramters.</li>
+        <li>Fiddle with various TOTP parameters.</li>
       </ul>
       <p class="card-text">What this tool <strong>can't</strong> do:</p>
       <ul class="card-text">