From b56b3cc3ce294cafd40fa73b59a53138bf7c8387 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dawid=20Wysoki=C5=84ski?= Date: Sun, 11 Dec 2022 10:35:16 +0100 Subject: [PATCH] chore: update README.md --- README.md | 34 +++++++++++++++++++++------------- 1 file changed, 21 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 125f726..fe3b064 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,39 @@ ### gootp -gootp is a terminal-based 2FA (Two-Factor Authentication) app. - [![asciicast](https://asciinema.org/a/s9eF7EbqgnCkoLVwbv0TE0a8Y.svg)](https://asciinema.org/a/s9eF7EbqgnCkoLVwbv0TE0a8Y) +gootp is a terminal-based 2FA (Two-Factor Authentication) app. + ## Features - Supported algorithms: TOTP -- Compatible with [andOTP](https://github.com/andOTP/andOTP) file format -- Allows to encrypt/decrypt andOTP files on your PC +- Compatible with [andOTP](https://github.com/andOTP/andOTP) backup file format +- Encrypt/decrypt andOTP backup files on your PC ## Installation -Requirements: +Prerequisites: 1. Go 1.19+ -2. [Exported andOTP file](https://github.com/andOTP/andOTP#backups=) +2. [Backup file](https://github.com/andOTP/andOTP#backups=) ```shell go install gitea.dwysokinski.me/Kichiyaki/gootp@latest -cp /path/to/andotp/file ~/.otp_accounts.json # !IMPORTANT! this file must be encrypted +cp /path/to/andotp/file ~/.otp_accounts.json # !IMPORTANT! this backup file must be encrypted ``` ## Examples ```shell -gootp # show OTP list -gootp -h # help for gootp -gootp -p /path/to/andotp/file/.otp_accounts.json # override default path -gootp --password xxx # specify encryption password via flag -gootp -p /path/to/andotp/file/.otp_accounts.json encrypt -o /output/.otp_accounts.json.aes # encrypt file -gootp -p /path/to/andotp/file/.otp_accounts.json decrypt -o /output/.otp_accounts.json.aes # decrypt file +gootp # start gootp +gootp -h # show a list of commands +gootp -p /path/to/andotp/file/.otp_accounts.json # override the default path +gootp --password xxx # specify an encryption password via flag +gootp -p /path/to/andotp/file/.otp_accounts.json encrypt -o /output/.otp_accounts.json.aes # encrypt a file +gootp -p /path/to/andotp/file/.otp_accounts.json decrypt -o /output/.otp_accounts.json.aes # decrypt a file ``` + +## License + +Distributed under the MIT License. See ``LICENSE`` for more information. + +## Contact + +Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)