diff --git a/README.md b/README.md index 9b671ff..9b0ce21 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ SeedPass now uses the `portalocker` library for cross-platform file locking. No - [Managing Multiple Seeds](#managing-multiple-seeds) - [Additional Entry Types](#additional-entry-types) - [Building a standalone executable](#building-a-standalone-executable) +- [Packaging with Briefcase](#packaging-with-briefcase) - [Security Considerations](#security-considerations) - [Contributing](#contributing) - [License](#license) @@ -609,6 +610,27 @@ package for your platform. The standalone executable will appear in the `dist/` directory. This process works on Windows, macOS and Linux but you must build on each platform for a native binary. +## Packaging with Briefcase + +For step-by-step instructions see [docs/docs/content/01-getting-started/05-briefcase.md](docs/docs/content/01-getting-started/05-briefcase.md). + +Install Briefcase and create a platform-specific scaffold: + +```bash +python -m pip install briefcase +briefcase create +``` + +Build and run the packaged GUI: + +```bash +briefcase build +briefcase run +``` + +You can also launch the GUI directly with `seedpass gui` or `seedpass-gui`. + + ## Security Considerations **Important:** The password you use to encrypt your parent seed is also required to decrypt the seed index data retrieved from Nostr. **It is imperative to remember this password** and be sure to use it with the same seed, as losing it means you won't be able to access your stored index. Secure your 12-word seed **and** your master password.