diff --git a/README.md b/README.md index ac67491..10db12a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ [![golangci-lint](https://github.com/everstake/bip39/actions/workflows/golangci-lint.yaml/badge.svg)](https://github.com/everstake/bip39/actions/workflows/golangci-lint.yaml) [![CodeQL](https://github.com/everstake/bip39/actions/workflows/codeql.yml/badge.svg)](https://github.com/everstake/bip39/actions/workflows/codeql.yml) [![Run Gosec](https://github.com/everstake/bip39/actions/workflows/gosec.yml/badge.svg)](https://github.com/everstake/bip39/actions/workflows/gosec.yml) [![Go Build](https://github.com/everstake/bip39/actions/workflows/go.yml/badge.svg)](https://github.com/everstake/bip39/actions/workflows/go.yml) [![goreleaser](https://github.com/everstake/bip39/actions/workflows/goreleaser.yml/badge.svg)](https://github.com/everstake/bip39/actions/workflows/goreleaser.yml) -# Generation, verification of mnemonics in BIP39 standard and obtaining their hash in Argon2id format +## CLI for generation and verification of mnemonics in BIP39 with hash in Argon2id +![BIP39 mnemonics generation tool](assets/images/generate_example_1.png) -### Fork: https://github.com/tyler-smith/go-bip39 -## Build +### Build go build cmd/cli/bip39.go -## Install +### Install sudo install -t /usr/local/bin bip39 -## BIP39 mnemonic generation +### BIP39 mnemonic generation bip39 generate --words value Word count (default: 24) @@ -21,7 +21,7 @@ --dir value Save file to directory (default: ~/bip39/mnemonics) -## Check existing BIP39 mnemonic +### Check existing BIP39 mnemonic bip39 existing --color value First and last word color highlighting (default: green,blue) @@ -29,3 +29,10 @@ --save value Save to file [yes/no] (default: no) File name format: _.bip39 --dir value Save file to directory (default: ~/bip39/mnemonics) + +### Thanks +Thanks to Tyler Smith for providing the implementation of [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) in [Golang](https://github.com/tyler-smith/go-bip39) that allowed us to create this tool! + +### License +This BIP39 tool is released under the terms of the MIT license. +See LICENSE for more information or see https://opensource.org/licenses/MIT. \ No newline at end of file diff --git a/assets/images/generate_example_1.png b/assets/images/generate_example_1.png new file mode 100644 index 0000000..45cf31a Binary files /dev/null and b/assets/images/generate_example_1.png differ