diff --git a/README.md b/README.md index 2c74f8c..4724bae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # keycard-cli -`keycard-cli` is a command line tool to manage [Status Keycards](https://github.com/status-im/status-keycard). +`keycard` is a command line tool to manage [Status Keycards](https://github.com/status-im/status-keycard). * [Dependencies](#dependencies) * [Installation](#installation) @@ -14,18 +14,11 @@ ## Dependencies -To install `keycard-cli` you need `go` in your system. - -MacOSX: - -`brew install go` +On linux you need to install and run the [pcsc daemon](https://linux.die.net/man/8/pcscd). ## Installation -`go get -u github.com/status-im/keycard-cli` - -The executable will be installed in `$GOPATH/bin`. -Check your `$GOPATH` with `go env`. +Download the binary for your platform from the [releases page](https://github.com/status-im/keycard-cli/releases). ## Continuous Integration @@ -41,7 +34,7 @@ Successful PR builds are mandatory. ### Card info ```bash -keycard-cli info -l debug +keycard info -l debug ``` The `info` command will print something like this: @@ -61,7 +54,7 @@ The `install` command will install an applet to the card. You can download the status `cap` file from the [status-im/status-keycard releases page](https://github.com/status-im/status-keycard/releases). ```bash -keycard-cli 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. @@ -71,7 +64,7 @@ In case the applet is already installed and you want to force a new installation ```bash -keycard-cli 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.