From 1c6700c165becac3372477db98d78cf52cac596d Mon Sep 17 00:00:00 2001 From: Andrea Franz Date: Mon, 18 Mar 2019 21:55:45 +0100 Subject: [PATCH] add README table of contents --- README.md | 35 +++++++++++++++++++++++------------ 1 file changed, 23 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index fefc4a4..09a6fe3 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,14 @@ `keycard-cli` is a command line tool to manage [Status Keycards](https://github.com/status-im/status-keycard). +* [Dependencies](#dependencies) +* [Installation](#intallation) +* [Card info](#card-info) +* [Keycard applet installation](#keycard-applet-installation) +* [Card initialization](#card-initialization) +* [Deleting the applet](#deleting-the-applet) +* [Keycard shell](#keycard-shell) + ## Dependencies To install `keycard-cli` you need `go` in your system. @@ -19,17 +27,6 @@ Check your `$GOPATH` with `go env`. ## Usage -### 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/status-keycard releases page](https://github.com/status-im/status-keycard/releases). - -```bash -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. - ### Card info ```bash @@ -47,6 +44,17 @@ Version: 0x AvailableSlots: 0x KeyUID: 0x ``` +### Keycard applet installation + +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 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. + ### Card initialization @@ -63,10 +71,13 @@ PUK 123456789012 Pairing password: RandomPairingPassword ``` -### Deleting the applet from the card +### Deleting the applet :warning: **WARNING! This command will remove the applet and all the keys from the card.** :warning: ```bash keycard delete -l debug ``` + +### Keycard shell +TODO