summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorAndreas Schneider <asn@samba.org>2019-02-19 16:18:10 +0100
committerAndreas Schneider <asn@samba.org>2019-02-20 17:24:04 +0100
commit70bc551dca142a7a4d6ed082244966957ca2e070 (patch)
tree76cf6d28eaf371b46d1a8761ea4ea6b68ae7da86 /README.md
parent5cc06814060cd99245e7f072da077e5227d7698d (diff)
downloadsocket_wrapper-70bc551dca142a7a4d6ed082244966957ca2e070.tar.gz
socket_wrapper-70bc551dca142a7a4d6ed082244966957ca2e070.tar.xz
socket_wrapper-70bc551dca142a7a4d6ed082244966957ca2e070.zip
README: Create a markdown file
Signed-off-by: Andreas Schneider <asn@samba.org> Reviewed-by: Stefan Metzmacher <metze@samba.org>
Diffstat (limited to 'README.md')
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3e0ca5d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+SOCKET_WRAPPER
+==============
+
+This is a library passing all socket communications through unix sockets.
+
+DESCRIPTION
+-----------
+
+More details can be found in the manpage:
+
+ man -l ./doc/socket_wrapper.1
+
+or the raw text version:
+
+ less ./doc/socket_wrapper.1.txt
+
+For installation instructions please take a look at the README.install file.
+
+MAILINGLIST
+-----------
+
+As the mailing list samba-technical is used and can be found here:
+
+* https://lists.samba.org/mailman/listinfo/samba-technical