From 2b942ec5f2af1b60d05c7469ce9d209c27888c58 Mon Sep 17 00:00:00 2001
From: Nikolay Kim <fafhrd91@gmail.com>
Date: Mon, 5 Mar 2018 09:47:17 -0800
Subject: [PATCH] add uds example readme

---
 examples/unix-socket/README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 examples/unix-socket/README.md

diff --git a/examples/unix-socket/README.md b/examples/unix-socket/README.md
new file mode 100644
index 000000000..03b0066a2
--- /dev/null
+++ b/examples/unix-socket/README.md
@@ -0,0 +1,14 @@
+## Unix domain socket example
+
+```bash
+$ curl --unix-socket /tmp/actix-uds.socket http://localhost/
+Hello world!
+```
+
+Although this will only one thread for handling incoming connections 
+according to the 
+[documentation](https://actix.github.io/actix-web/actix_web/struct.HttpServer.html#method.start_incoming).
+
+And it does not delete the socket file (`/tmp/actix-uds.socket`) when stopping
+the server so it will fail to start next time you run it unless you delete
+the socket file manually.