Skip to content

Commit 2b71b60

Browse files
committed
Update README.md
1 parent 289e041 commit 2b71b60

File tree

1 file changed

+19
-4
lines changed

1 file changed

+19
-4
lines changed

README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,35 @@ This tool allows for decrypting the encrypted backups/account files created by [
44

55
If you find problems with the file format (in particular security related issues), do not hesitate and file an issue.
66

7-
## Usage
8-
9-
Requires:
7+
## Requirements
108

119
- [Python 3.7](https://www.python.org/downloads/)
12-
- [pipenv](https://docs.pipenv.org)
10+
- [pipenv](https://github.com/pypa/pipenv)
1311
- An encrypted OTP Auth backup/account file
1412

13+
## Usage
14+
15+
1. Clone repository
16+
1517
```
1618
git clone https://github.com/CooperRS/decrypt-otpauth-files.git
1719
cd decrypt-otpauth-files
20+
```
21+
22+
2. Install dependencies
23+
24+
```
1825
pipenv install
26+
```
27+
28+
3. Decrypt your OTP Auth file
29+
30+
```
1931
# Decrypt a full backup file
2032
pipenv run python decrypt_otpauth.py decrypt_backup --encrypted-otpauth-backup <path to your OTP Auth backup>
33+
```
34+
35+
```
2136
# Decrypt a single account export
2237
pipenv run python decrypt_otpauth.py decrypt_account --encrypted-otpauth-account <path to your OTP Auth account>
2338
```

0 commit comments

Comments
 (0)