thePR0M3TH3AN/seedPass
1
0
Fork 0
mirror of https://github.com/PR0M3TH3AN/SeedPass.git synced 2025-09-09 07:48:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #78 from PR0M3TH3AN/codex/update-readme-to-match-current-app

Browse Source 
Improve README to match TUI
This commit is contained in:
thePR0M3TH3AN
2025-07-01 00:21:58 -04:00
committed by GitHub
parent eaba2aee56 1d49cbf142
commit 578df8d7b7
1 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@@ -41,8 +41,8 @@ SeedPass now uses the `portalocker` library for cross-platform file locking. No
- **Encrypted Storage:** All seeds, login passwords, and sensitive index data are encrypted locally. - **Encrypted Storage:** All seeds, login passwords, and sensitive index data are encrypted locally.
- **Nostr Integration:** Post and retrieve your encrypted password index to/from the Nostr network. - **Nostr Integration:** Post and retrieve your encrypted password index to/from the Nostr network.
- **Checksum Verification:** Ensure the integrity of the script with checksum verification. - **Checksum Verification:** Ensure the integrity of the script with checksum verification.
- **Multiple Seed Profiles:** Manage multiple seed profiles and switch between them seamlessly. - **Multiple Seed Profiles:** Manage separate seed profiles and switch between them seamlessly.
- **User-Friendly CLI:** Simple command-line interface for easy interaction. - **Interactive TUI:** Navigate through menus to add, retrieve, and modify entries as well as configure Nostr settings.
## Prerequisites ## Prerequisites
@@ -166,18 +166,25 @@ wss://nostr.oxtr.dev
wss://relay.primal.net wss://relay.primal.net
``` ```
You can manage the relay list or change the PIN through the **Settings** menu: You can manage your relays and sync with Nostr from the **Settings** menu:
1. From the main menu, choose option `4` (**Settings**). 1. From the main menu choose `4` (**Settings**).
2. Select `2` (**Nostr**) to open the Nostr submenu. 2. Select `2` (**Nostr**) to open the Nostr submenu.
3. Choose `3` to view your current relays. 3. Choose `1` to back up your encrypted index to Nostr.
4. Select `4` to add a new relay URL. 4. Select `2` to restore the index from Nostr.
5. Choose `5` to remove a relay by number. 5. Choose `3` to view your current relays.
6. Select `6` to reset to the default relay list. 6. Select `4` to add a new relay URL.
7. Choose `7` to display your Nostr public key. 7. Choose `5` to remove a relay by number.
8. Select `8` to return to the Settings menu. 8. Select `6` to reset to the default relay list.
9. From the Settings menu you can select `3` to change the settings PIN. 9. Choose `7` to display your Nostr public key.
10. Choose `4` to verify the script checksum or `5` to back up the parent seed. 10. Select `8` to return to the Settings menu.
Back in the Settings menu you can:
* Select `3` to change your master password.
* Choose `4` to verify the script checksum.
* Choose `5` to back up the parent seed.
* Choose `6` to lock the vault and require re-entry of your password.
## Running Tests ## Running Tests