|
| 1 | +# 👋 Welcome to Keycard |
1 | 2 |
|
2 | | -# What is Keycard? |
| 3 | +We’re building open, secure, and privacy-respecting tools for self-custody and digital sovereignty. |
3 | 4 |
|
4 | | -Keycard is an implementation of a BIP-32 HD wallet running on Javacard 3.0.4+ (see implementation notes) |
| 5 | +--- |
5 | 6 |
|
6 | | -It supports among others |
7 | | -- key generation, derivation and signing |
8 | | -- exporting keys defined in the context of EIP-1581 https://eips.ethereum.org/EIPS/eip-1581 |
9 | | -- setting up a NFC NDEF tag |
| 7 | +## 🔧 What We Do |
10 | 8 |
|
11 | | -Communication with the Keycard happens through a simple APDU interface, together with a Secure Channel guaranteeing confidentiality, authentication and integrity of all commands. It supports both NFC and ISO7816 physical interfaces, meaning that it is compatible with any Android phone equipped with NFC, and all USB Smartcard readers. |
| 9 | +- 🔑 **[Status Keycard](https://github.com/keycard-tech/status-keycard)** — A JavaCard applet implementing a BIP-32 HD wallet. |
| 10 | +- 🛠️ **[Keycard Shell](https://github.com/keycard-tech/keycard-shell)** — A modular hardware wallet which uses Keycard as a secure element. |
12 | 11 |
|
13 | | -The most obvious case for integration of Keycard is crypto wallets (ETH, BTC, etc), however it can be used in other systems where a BIP-32 key tree is used and/or you perform authentication/identification. |
| 12 | +Explore all our repositories in the [Keycard Tech GitHub repositories](https://github.com/orgs/keycard-tech/repositories). |
14 | 13 |
|
15 | | -# Where to start? |
| 14 | +--- |
16 | 15 |
|
17 | | -A good place to start is our [documentation site](https://keycard.tech/docs/) |
| 16 | +## 🤝 How to Contribute |
18 | 17 |
|
19 | | -Keycard is a public good — contributions are welcome and highly encouraged! |
| 18 | +**Keycard is a public good — contributions are highly encouraged!** |
| 19 | +You can help by contributing code, testing, improving documentation, or suggesting new ideas. |
20 | 20 |
|
21 | | -You can also join the discussion about this project on our [discord channel](https://discord.gg/uJAXk7jFhZ) |
| 21 | +- Check out our [documentation site](https://keycard.tech/docs/) |
| 22 | +- Explore the existing [ecosystem of projects](https://github.com/keycard-tech/keycard-ecosystem-projects/) |
| 23 | +- Check [good first issues](https://github.com/orgs/keycard-tech/projects/1/views/2?filterQuery=good+first+issue) |
| 24 | +- Share feedback or ideas! |
22 | 25 |
|
23 | | -Keycard is at the center of several projects, check the [ecosystem of projects](https://github.com/keycard-tech/keycard-ecosystem-projects/) or [good first issues](https://github.com/orgs/keycard-tech/projects/1/views/2?filterQuery=good+first+issue) |
| 26 | +--- |
24 | 27 |
|
25 | | -Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on it. This is to prevent duplicated efforts from contributors on the same issue. |
| 28 | +## 📬 Stay in Touch |
26 | 29 |
|
27 | | -If you just want to use the Keycard as your hardware wallet there are currently three apps supporting it |
| 30 | +- 🌐 Website: [keycard.tech](https://getkeycard.com) |
| 31 | +- 💬 Community: [Keycard discord](https://discord.gg/uJAXk7jFhZ) |
| 32 | +- 🐦 Twitter: [@keycard_](https://twitter.com/keycard_) |
28 | 33 |
|
29 | | -1. Status [[Android](https://play.google.com/store/apps/details?id=im.status.ethereum)][[iOS](https://apps.apple.com/us/app/status-private-communication/id1178893006)] |
30 | | -2. WallETH [[Android](https://play.google.com/store/apps/details?id=org.walleth)] |
31 | | -3. Enno Walet https://ennowallet.com/ |
| 34 | +--- |
| 35 | + |
| 36 | +> _Built with ❤️ by a community of builders who believe in open security and permissionless technology._ |
0 commit comments