From 6e97beb09c7d8ff791463f3ec3b707028e7c8b7c Mon Sep 17 00:00:00 2001
From: Till Klocke <till.klocke@gmail.com>
Date: Thu, 28 Sep 2023 18:33:28 +0200
Subject: [PATCH] Added readme file

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d9e8a15
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# andotp-converter
+
+Sadly andOTP is not maintained anymore. While there are 2FA apps like https://getaegis.app/ which allow
+importing TOTP secrets from andOTP I wanted to migrate to [2FAS](https://2fas.com/). Since 2FAS can't 
+import andOTP data and I didn't want to take a detour over Aegis I created a small toool which
+can convert andOTP exports into 2FAS backup files.
+For my case it worked sufficiently well.
+
+## Usage
+
+`andotp-converter <path-to-andotp-export> <where-the-2fas-file-should-be-created>` That's it.
+Please note that you need to use an unecrypted andOTP export and this tool creates an unecrypted
+2FAS backup file.