summaryrefslogtreecommitdiffstats
path: root/python/python-yenc/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/python-yenc/README')
-rw-r--r--python/python-yenc/README7
1 files changed, 7 insertions, 0 deletions
diff --git a/python/python-yenc/README b/python/python-yenc/README
new file mode 100644
index 0000000000..716a3a3ab8
--- /dev/null
+++ b/python/python-yenc/README
@@ -0,0 +1,7 @@
+ yEnc - a raw encoding/decoding module for Python
+
+This a fairly simple module, it provide only raw yEnc encoding/decoding with
+builitin crc32 calculation.
+Header parsing, checkings and yenc formatting are left to you (see examples
+directory for possible implementations). The interface was originally intended
+to be similar to the uu module from Python standard library.