diff --git a/README.md b/README.md index ba5591c..1d548d7 100644 --- a/README.md +++ b/README.md @@ -14,33 +14,55 @@ See SatoshiLabs' blog posts about this feature: ## Installation -First, make sure that the latest [trezorlib](https://pypi.python.org/pypi/trezor) Python package -is installed correctly (at least v0.6.6): +Install the following packages: $ apt-get install python-dev libusb-1.0-0-dev libudev-dev $ pip install -U setuptools pip - $ pip install Cython trezor + +Make sure you are running the latest firmware version on your hardware device. +Currently the following firmware versions are supported: + + * [TREZOR](https://wallet.trezor.io/data/firmware/releases.json): `1.4.2+` + * [KeepKey](https://github.com/keepkey/keepkey-firmware/releases): `3.0.17+` + * [Ledger Nano S](https://github.com/LedgerHQ/blue-app-ssh-agent): `0.0.3+` + +### TREZOR Make sure that your `udev` rules are configured [correctly](https://doc.satoshilabs.com/trezor-user/settingupchromeonlinux.html#manual-configuration-of-udev-rules). Then, install the latest [trezor_agent](https://pypi.python.org/pypi/trezor_agent) package: $ pip install trezor_agent -Or, directly from the latest source code (if `pip` doesn't work for you): +Or, directly from the latest source code: - $ git clone https://github.com/romanz/trezor-agent && cd trezor-agent - $ python setup.py build && python setup.py install + $ git clone https://github.com/romanz/trezor-agent + $ pip install --user -e trezor-agent/agents/trezor -Finally, verify that you are running the latest [TREZOR firmware](https://wallet.mytrezor.com/data/firmware/releases.json) version (at least v1.4.0): +If you have an error regarding `protobuf` imports (after installing it), please see [this issue](https://github.com/romanz/trezor-agent/issues/28). - $ trezorctl get_features | head - vendor: "bitcointrezor.com" - major_version: 1 - minor_version: 4 - patch_version: 0 - ... +### KeepKey -If you have an error regarding `protobuf` imports (after installing it), please see [this issue](https://github.com/romanz/trezor-agent/issues/28). +Make sure that your `udev` rules are configured [correctly](https://support.keepkey.com/support/solutions/articles/6000037796-keepkey-wallet-is-not-being-recognized-by-linux). +Then, install the latest [keepkey_agent](https://pypi.python.org/pypi/keepkey_agent) package: + + $ pip install keepkey_agent + +Or, directly from the latest source code: + + $ git clone https://github.com/romanz/trezor-agent + $ pip install --user -e trezor-agent/agents/keepkey + +### Ledger Nano S + +Make sure that your `udev` rules are configured [correctly](http://support.ledgerwallet.com/knowledge_base/topics/ledger-wallet-is-not-recognized-on-linux). +Then, install the latest [ledger_agent](https://pypi.python.org/pypi/ledger_agent) package: + + $ pip install ledger_agent + +Or, directly from the latest source code: + + $ git clone https://github.com/romanz/trezor-agent + $ pip install --user -e trezor-agent/agents/ledger ## Usage diff --git a/agents/keepkey/setup.py b/agents/keepkey/setup.py index 303c266..856a279 100644 --- a/agents/keepkey/setup.py +++ b/agents/keepkey/setup.py @@ -4,7 +4,7 @@ from setuptools import setup setup( name='keepkey_agent', version='0.9.0', - description='Using KeepKey as hardware SSH agent', + description='Using KeepKey as hardware SSH/GPG agent', author='Roman Zeyde', author_email='roman.zeyde@gmail.com', url='http://github.com/romanz/trezor-agent', diff --git a/agents/ledger/setup.py b/agents/ledger/setup.py index 7d8baf6..ca0673f 100644 --- a/agents/ledger/setup.py +++ b/agents/ledger/setup.py @@ -4,7 +4,7 @@ from setuptools import setup setup( name='ledger_agent', version='0.9.0', - description='Using Ledger as hardware SSH agent', + description='Using Ledger as hardware SSH/GPG agent', author='Roman Zeyde', author_email='roman.zeyde@gmail.com', url='http://github.com/romanz/trezor-agent', diff --git a/agents/trezor/setup.py b/agents/trezor/setup.py index 433796a..5021996 100644 --- a/agents/trezor/setup.py +++ b/agents/trezor/setup.py @@ -4,7 +4,7 @@ from setuptools import setup setup( name='trezor_agent', version='0.9.0', - description='Using Trezor as hardware SSH agent', + description='Using Trezor as hardware SSH/GPG agent', author='Roman Zeyde', author_email='roman.zeyde@gmail.com', url='http://github.com/romanz/trezor-agent',