status-im
/
keycard-site
mirror of https://github.com/status-im/keycard-site.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

add Keycard Connect tip

This commit is contained in:
Michele Balistreri 2020-06-03 09:36:23 +03:00 committed by Jakub Sokołowski
parent 34d88f1d3c
commit a79765ba4a
No known key found for this signature in database
GPG Key ID: 4EF064D0E6D63020
3 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/_data/sidebar.yml
View File

@ -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

7
source/docs/applet_installation.md
View File

@ -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.

2
source/docs/resources.md
View File

@ -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)