diff options
| author | heqnx <root@heqnx.com> | 2025-06-03 23:26:36 +0300 |
|---|---|---|
| committer | heqnx <root@heqnx.com> | 2025-06-03 23:26:36 +0300 |
| commit | d0f8c3cc16f60f2024df240c3da7b8e6b387e113 (patch) | |
| tree | e3faf9bc669e7ba985c1a8dc1660295290e62ce9 | |
| parent | 548917cd8345bdd920d34a160dd8382e6601bb1c (diff) | |
| download | ssh-bip39gen-d0f8c3cc16f60f2024df240c3da7b8e6b387e113.tar.gz ssh-bip39gen-d0f8c3cc16f60f2024df240c3da7b8e6b387e113.zip | |
updated README
| -rw-r--r-- | README.md | 23 |
1 files changed, 9 insertions, 14 deletions
@@ -14,6 +14,7 @@ ### Pre-built Binaries Download the latest release from the [Releases page](https://github.com/heqnx/ssh-bip39gen/releases) for your platform: + - `ssh-bip39gen-linux-amd64` - `ssh-bip39gen-linux-386` - `ssh-bip39gen-windows-amd64.exe` @@ -30,7 +31,7 @@ Requires Go 1.21+ and `make`. 1. Clone the repository: ``` -$ git clone https://github.com/heqnx/ssh-bip39gen.git +$ git clone https://cgit.heqnx.com/ssh-bip39gen $ cd ssh-bip39gen ``` @@ -60,10 +61,10 @@ $ make clean ### Generate a New Key Pair ``` -$ ssh-bip39gen +$ ssh-bip39gen -f key ``` -- Creates id_ed25519 (private) and id_ed25519.pub (public). +- Creates `key` (private) and `key.pub` (public). - 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! @@ -91,22 +92,16 @@ $ ssh-bip39gen -h - Displays usage instructions and flags. -## License - -- GNU GENERAL PUBLIC LICENSE Version 3 - ## 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. - Entropy: 256-bit entropy. - Determinism: If the mnemonic is compromised, an attacker can regenerate your keys. Use a unique, randomly generated mnemonic for each key pair. -Contributing -Feel free to submit issues or pull requests on GitHub. Ensure any changes maintain the 24-word mnemonic requirement and Ed25519 key type. -License -MIT License (LICENSE) - Free to use, modify, and distribute. +## License + +This project is licensed under the GNU GENERAL PUBLIC LICENSE. See the LICENSE file for details. -## Acknowledgments +## Disclaimer -- Built with Go, go-bip39, and x/crypto. -- Inspired by SSH key management needs and BIP-39's mnemonic standard. +`ssh-bip39gen` is provided "as is" without warranty. The author and contributors are not liable for any damages or legal consequences arising from its use. Use responsibly and only in authorized environments. |