summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSlávek Banko <slavek.banko@axis.cz>2021-10-21 09:40:43 +0200
committerSlávek Banko <slavek.banko@axis.cz>2021-10-21 09:40:43 +0200
commit8c74875752d5373b922b1a35a7d60b851c6c7ce7 (patch)
tree2f0111193987f20b76f71c42e52edbfb5bd0182f /README.md
parent3eb77b4fcaf2284e9711d6fbe757b4f882cd7c4d (diff)
downloadsmartcardauth-8c74875752d5373b922b1a35a7d60b851c6c7ce7.tar.gz
smartcardauth-8c74875752d5373b922b1a35a7d60b851c6c7ce7.zip
Change README to markdown format.
Signed-off-by: Slávek Banko <slavek.banko@axis.cz>
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d06a4c2
--- /dev/null
+++ b/README.md
@@ -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