diff --git a/cmd/keycard/README.md b/cmd/keycard/README.md index 1ef91b5..7c85df8 100644 --- a/cmd/keycard/README.md +++ b/cmd/keycard/README.md @@ -1,10 +1,10 @@ -# status-hardware-wallet +# keycard -`status-hardware-wallet` is a command line tool you can use to initialize a smartcard with the [Status Hardware Wallet](https://github.com/status-im/hardware-wallet). +`keycard` is a command line tool you can use to initialize a smartcard with the [Status Keycard](https://github.com/status-im/status-keycard). ## Dependencies -To install `hardware-wallet-go` you need `go` in your system. +To install `keycard-go` you need `go` in your system. MacOSX: @@ -12,20 +12,20 @@ MacOSX: ## Installation -`go get github.com/status-im/hardware-wallet-go/cmd/status-hardware-wallet` +`go get github.com/status-im/keycard-go/cmd/keycard` The executable will be installed in `$GOPATH/bin`. Check your `$GOPATH` with `go env`. ## Usage -### Install the hardware wallet applet +### Install the keycard applet The install command will install an applet to the card. -You can download the status `cap` file from the [status-im/hardware-wallet releases page](https://github.com/status-im/hardware-wallet/releases). +You can download the status `cap` file from the [status-im/status-keycard releases page](https://github.com/status-im/status-keycard/releases). ```bash -status-hardware-wallet install -l debug -a PATH_TO_CAP_FILE +keycard install -l debug -a PATH_TO_CAP_FILE ``` In case the applet is already installed and you want to force a new installation you can pass the `-f` flag. @@ -33,7 +33,7 @@ In case the applet is already installed and you want to force a new installation ### Card info ```bash -status-hardware-wallet info -l debug +keycard info -l debug ``` The `info` command will print something like this: @@ -52,7 +52,7 @@ KeyUID: 0x ```bash -status-hardware-wallet init -l debug +keycard init -l debug ``` The `init` command initializes the card and generates the secrets needed to pair the card to a device. @@ -68,13 +68,13 @@ Pairing password: RandomPairingPassword :warning: **WARNING! This command will remove the applet and all the keys from the card.** :warning: ```bash -status-hardware-wallet delete -l debug +keycard delete -l debug ``` ### Pairing ```bash -status-hardware-wallet pair -l debug +keycard pair -l debug ``` The process will ask for `PairingPassword` and `PIN` and will generate a pairing key you can use to interact with the card.