diff --git a/README.md b/README.md index 97456e7..c301bc5 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ SeedPass now uses the `portalocker` library for cross-platform file locking. No - **Checksum Verification:** Ensure the integrity of the script with checksum verification. - **Multiple Seed Profiles:** Manage separate seed profiles and switch between them seamlessly. - **Interactive TUI:** Navigate through menus to add, retrieve, and modify entries as well as configure Nostr settings. +- **SeedPass 2FA:** Generate TOTP codes with a real-time countdown progress bar. ## Prerequisites diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..42dad0d --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +# SeedPass Documentation + +This directory contains supplementary guides for using SeedPass. + +## Quick Example: Get a TOTP Code + +Run `seedpass get-code` to retrieve a time-based one-time password (TOTP). A progress bar shows the remaining seconds in the current period. + +```bash +$ seedpass get-code --index 0 +[##########----------] 15s +Code: 123456 +``` + +See [advanced_cli.md](advanced_cli.md) for a full command reference.