diff --git a/README.md b/README.md index e2722b6..f1025ab 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # GAuth QR Reencoder -This tool is used to conver image files from Google Authenticator's QR code from both migration (export) and new TOTP. +This tool is used to convert QR code images from Google Authenticator's QR code from both migration (export) and new TOTP. ## Usage @@ -11,6 +11,25 @@ Execute the following to start the Python script: python3 gauth_reencoder.py ``` +## Dependencies + +The Python libraries required are stated in requirements.txt. You may execute the following command to install them. +``` +pip3 install requirements.txt +``` + +`zbar` library is also required on the OS for reading QR code. You may install it using the following: + +Ubuntu +``` +sudo apt install libzbar0 +``` + +Mac +``` +homebrew install zbar +``` + ## References This project utilises code from digitalduke (https://github.com/digitalduke/otpauth-migration-decoder) diff --git a/requirements.txt b/requirements.txt index f9fcc45..301aafc 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,4 @@ pillow pyzbar -qrcode \ No newline at end of file +qrcode +protobuf