summaryrefslogtreecommitdiffstats
path: root/libraries/compface/README
diff options
context:
space:
mode:
Diffstat (limited to 'libraries/compface/README')
-rw-r--r--libraries/compface/README6
1 files changed, 6 insertions, 0 deletions
diff --git a/libraries/compface/README b/libraries/compface/README
new file mode 100644
index 0000000000..8537ac46c2
--- /dev/null
+++ b/libraries/compface/README
@@ -0,0 +1,6 @@
+Compface converts 48x48x1 images to and from a compressed format.
+The purpose is to allow the inclusion of face images within mail
+headers using the field name 'X-face:'. It uses the library that
+can be used to allow the compression and decompression algorithms
+to be used in other programs such as mail dispatchers and mail
+notification daemons.