Change README to markdown format.r14.0.11

Add translation status overview.

Signed-off-by: Slávek Banko <slavek.banko@axis.cz>
(cherry picked from commit d5f9dc3865443d6d0f71d97c916531018880cef3)

1 files changed, 49 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dd86a59
--- /dev/null
+++ b/README.md
@@ -0,0 +1,49 @@
+
+ tdeio-ftps - an ftps ioslave for TDE.
+
+
+This ioslave implements the ftp encryption scheme called ftps, based on
+rfc 4217. The slave tries to use the encryption methods the server
+offers.
+
+
+Features:
+---------
+
+* Control channel encryption
+* Encrypted PASV data transfers
+
+
+Lacking:
+--------
+
+* Authentification via client certificate
+* Encrypted PORT data transfers
+
+
+NB: The slave issues an "AUTH TLS" command after connecting and refuses
+to continue, when it's not supported. In prior to every data channel io
+command ("STOR", "RETR", etc) It tries to secure the data channel via
+"PBSZ" and "PROT" commands. If those fail then It will transfer data
+unencrypted.
+
+.
+
+Contributing
+--------------
+
+If you wish to contribute to tdeio-ftps (TDE), 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
+
+
+Translations status
+---------------------
+
+### messages
+[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/tdeio-ftps/multi-auto.svg
+"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/tdeio-ftps/)