Skip to content

Commit

Permalink
added example png, added credits, license section
Browse files Browse the repository at this point in the history
  • Loading branch information
ank-everstake committed Jan 10, 2024
1 parent 68f85bb commit 9896cd1
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -21,11 +21,18 @@
--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)
Allowed colors: black, red, green, yellow, blue, magenta, cyan, white
--save value Save to file [yes/no] (default: no)
File name format: <Argon2idHash>_<TimestampUnixNano>.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.
Binary file added assets/images/generate_example_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9896cd1

Please sign in to comment.