1 files changed, 30 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..32fa007
--- /dev/null
+++ b/README
@@ -0,0 +1,30 @@
+
+ smartcardauth - a SmartCard Login and LUKS Decrypt Setup Utility for TDE.
+
+
+Smartcardauth will allow you to set up your computer to accept a
+SmartCard as an authentication source. It is designed to work with any
+OpenSC-supported, ISO 7816-4,-8 compliant, PKCS#11 enabled smartcard.
+
+Examples of such cards are:
+ - The OpenPGP card (ISO ISO 7816-4,-8 compliant)
+
+
+FEATURES:
+=========
+
+* support encrypted LUKS partition
+* automatic login, lock, and unlock
+
+
+
+CONTRIBUTING
+==============
+
+If you wish to contribute to smartcardauth, you might do so:
+
+- TDE Gitea Workspace (TGW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/gitea
+
+- TDE Weblate Translation Workspace (TWTW) collaboration tool.
+  https://mirror.git.trinitydesktop.org/weblate