From 363b4d633f946f1dd1832a4ec403b0d79e20064b Mon Sep 17 00:00:00 2001 From: Henrik Jonsson Date: Wed, 25 Sep 2019 12:16:35 +0200 Subject: [PATCH] Add components section --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6661d6c..64e43b2 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,20 @@ See the following blog posts about this tool: Currently [TREZOR One](https://trezor.io/), [TREZOR Model T](https://trezor.io/), [Keepkey](https://www.keepkey.com/), and [Ledger Nano S](https://www.ledgerwallet.com/products/ledger-nano-s) are supported. +## Components + +This repository contains source code for one library as well as +agents to interact with several different hardware devices: + +* [`libagent`](https://pypi.org/project/libagent/): shared library +* [`trezor-agent`](https://pypi.org/project/trezor-agent/): Using Trezor as hardware-based SSH/PGP agent +* [`ledger_agent`](https://pypi.org/project/ledger_agent/): Using Ledger as hardware-based SSH/PGP agent +* [`keepkey_agent`](https://pypi.org/project/keepkey_agent/): Using KeepKey as hardware-based SSH/PGP agent + + +The [/releases](/releases) page on Github contains the `libagent` +releases. + ## Documentation * **Installation** instructions are [here](doc/INSTALL.md) @@ -24,4 +38,4 @@ Currently [TREZOR One](https://trezor.io/), [TREZOR Model T](https://trezor.io/) Note: If you're using Windows, see [trezor-ssh-agent](https://github.com/martin-lizner/trezor-ssh-agent) by Martin Lízner. * **GPG** instructions and common use cases are [here](doc/README-GPG.md) -* Instructions to configure a Trezor-style **PIN entry** program are [here](doc/README-PINENTRY.md) \ No newline at end of file +* Instructions to configure a Trezor-style **PIN entry** program are [here](doc/README-PINENTRY.md)