diff --git a/source/_data/sidebar.yml b/source/_data/sidebar.yml index 3853335..9db5ca8 100644 --- a/source/_data/sidebar.yml +++ b/source/_data/sidebar.yml @@ -2,7 +2,7 @@ docs: - title: Docs path: docs children: - - title: Applet Installation + - title: Card Setup path: applet_installation.html - title: Resources path: resources.html diff --git a/source/docs/applet_installation.md b/source/docs/applet_installation.md index 0bb07dd..8c2b31d 100644 --- a/source/docs/applet_installation.md +++ b/source/docs/applet_installation.md @@ -1,11 +1,13 @@ --- id: applet_installation -title: Getting Started +title: Card Setup --- # Preparing the card -If you got a Keycard and you are integrating it in your project, you will most likely want to reset the applet status completely for testing purposes. This is done by reinstalling the applet, which can be accomplished using the [Keycard CLI](https://github.com/status-im/keycard-cli). To use the Keycard CLI, a USB reader is needed to be able to communicate with the card. +Keycard ships with all applets fully installed but not initialized. The most convenient way to initialize and manage the card is to install the [Keycard Connect](https://github.com/status-im/keycard-connect) Android app. It allows to fully initialize a card with pairing key, PIN, PUK and BIP39 seed. It also provides basic functionality like changing credentials, changing or removing keys and clear pairing slots. The last functionality is especially useful if you are integrating with Keycard and accidentally fill all pairing slots. Using the "Unpair others" button will remove all pairing except the Keycard Connect's one. + +In some cases you might want to reset the applet status completely for testing purposes. This is done by reinstalling the applet, which can be accomplished using the [Keycard CLI](https://github.com/status-im/keycard-cli). To use the Keycard CLI, a USB reader is needed to be able to communicate with the card. The repository contains example scripts for applet reinstallation. ## Card requirements @@ -28,4 +30,3 @@ Best performance is achieved if the card supports: * Signature.ALG_HMAC_SHA_512 Keycard requires about 10kb of NVM. All allocations, instantiations and checks are performed at installation time, so if installation succeeds, the applet will work fine. - diff --git a/source/docs/resources.md b/source/docs/resources.md index 32b5f1b..d6ed54d 100644 --- a/source/docs/resources.md +++ b/source/docs/resources.md @@ -17,4 +17,6 @@ Here you find the links to all repositories and tools related to Keycard develop * [React Native library](https://github.com/status-im/react-native-status-keycard) ## Tools + * [Keycard CLI](https://github.com/status-im/keycard-cli) +* [Keycard Connect](https://github.com/status-im/keycard-connect) \ No newline at end of file