diff options
| author | heqnx <root@heqnx.com> | 2025-06-03 23:32:18 +0300 |
|---|---|---|
| committer | heqnx <root@heqnx.com> | 2025-06-03 23:32:18 +0300 |
| commit | 5e0211fd4cbfd90b284713a1b75a42b6ff0aee64 (patch) | |
| tree | 88a3449452f8f7d99f4d2aca8a0b7c04f6dd860e /README.md | |
| parent | d0f8c3cc16f60f2024df240c3da7b8e6b387e113 (diff) | |
| download | ssh-bip39gen-5e0211fd4cbfd90b284713a1b75a42b6ff0aee64.tar.gz ssh-bip39gen-5e0211fd4cbfd90b284713a1b75a42b6ff0aee64.zip | |
updated README
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 15 insertions, 33 deletions
@@ -11,49 +11,39 @@ ## Installation -### Pre-built Binaries +### Prerequisites -Download the latest release from the [Releases page](https://github.com/heqnx/ssh-bip39gen/releases) for your platform: +- **Go**: Version 1.21 or later. +- **Make**: For building with the provided Makefile. +- **Git**: To clone the repository. -- `ssh-bip39gen-linux-amd64` -- `ssh-bip39gen-linux-386` -- `ssh-bip39gen-windows-amd64.exe` -- `ssh-bip39gen-windows-386.exe` -- `ssh-bip39gen-darwin-amd64` -- `ssh-bip39gen-darwin-arm64` +### Steps -Move the binary to a directory in your PATH (e.g., `/usr/local/bin` on Unix-like systems). - -### Build from Source - -Requires Go 1.21+ and `make`. - -1. Clone the repository: +- Clone the repository: ``` $ git clone https://cgit.heqnx.com/ssh-bip39gen $ cd ssh-bip39gen ``` -2. Build all binaries: +- Install dependencies: ``` -$ make +$ go mod tidy ``` -- Output is in the build/ directory. +- Build for all platforms: -3. (Optional) Build for a specific platform: ``` -$ make linux -$ make windows -$ make darwin +$ make all ``` -4. Clean up: +- Binaries will be generated in the build/ directory for Linux, Windows, and macOS; alternatively, build for a specific platform: ``` -$ make clean +$ make linux-amd64 +$ make windows-amd64 +$ make darwin-arm64 ``` ## Usage @@ -68,7 +58,7 @@ $ ssh-bip39gen -f key - Outputs a 24-word mnemonic (e.g., "abandon ability able about ... actress"). - Save the mnemonic securely - it’s your only way to regenerate the keys! -### Generate with Custom Output File +### Generate new deterministic key ``` $ ssh-bip39gen -f testkey @@ -84,14 +74,6 @@ $ ssh-bip39gen -f testkey -mnemonic "abandon ability able about above absent abs - Regenerates the same key pair using the provided 24-word mnemonic. -### Help - -``` -$ ssh-bip39gen -h -``` - -- Displays usage instructions and flags. - ## Security Notes - Mnemonic Security: The mnemonic is your private key. Treat it like a secret - write it down on paper, store it in a safe, or use a hardware wallet. Do not store it digitally unless encrypted. |