add bridge info in README

keepkey · markrypto · Sep 30, 2021 · Jul 21, 2021 · Jul 27, 2021 · Jul 28, 2021
commit e228f1d54b37cfc52983a9260f986f66a6e5b94c
diff --git a/README.rst b/README.rst
@@ -118,3 +118,51 @@ Release Process
   * sudo python3 setup.py sdist bdist_wheel bdist_egg
 * Upload the release
   * sudo python3 -m twine upload dist/* -s --sign-with gpg2
+
+KeepKey Bridge
+==============
+The KeepKey Bridge is a standalone TCP-to-webusb bridge the KeepKey. It runs a python-keepkey client
+based process that allows a local host-based process to communicate with the KeepKey wallet, thus
+bypassing the need for a webusb connection from a browser based platform.
+
+The KeepKey Bridge is recommended only for advanced users who have problems connecting the KeepKey
+on Windows.
+
+Running the KeepKey Bridge
+--------------------------
+Download the KeepKey Bridge installer for Windows here:
+
+
+Build for Windows
+-----------------
+Requirements:
+    Windows 10
+    python3
+    waitress (python package)
+    py2exe
+    Inno Setup Compiler (for creating Windows install exe)
+
+From a command prompt terminal window, run
+
+.. code:: shell
+    python wbsetup.py py2exe -d windows/dist
+
+This will create a ``windows\dist`` folder with the Windows stand-alone executable file ``wait-serv.exe``
+
+Inno Setup Compiler
+-------------------
+This tool builds and packages the executable for install on Windows. Build with the provided installer 
+script (modify version, etc., as needed)
+
+.. code:: shell
+    windows/KeepKeyBridge.iss
+
+This will produce an executable install app
+
+.. code:: shell
+    windows/Output/kkbsetup.exe
+
+Running the KeepKey Bridge
+--------------------------
+When running the KeepKey Bridge, a blank cmd window with the title "KepKey Bridge" will be visible. 
+To stop the bridge, simply close the cmd window.