From 4d3e2af714b59c36b28c1cd9bc59b7bee8cf1cd5 Mon Sep 17 00:00:00 2001
From: Joe Biellik <joebiellik@gmail.com>
Date: Tue, 17 May 2016 18:44:13 +0100
Subject: [PATCH] Add readme

---
 README.md | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c70530f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,29 @@
+# Samba server
+[Samba 4](https://www.samba.org/) server running under [s6 overlay](https://github.com/just-containers/s6-overlay) on [Alpine Linux](https://hub.docker.com/_/alpine/). Runs both `smbd` and `nmbd` services.
+
+## Configuration
+See [example directory](https://github.com/jcbiellikltd/docker-samba-server/tree/master/example) for sample config file.
+
+## Quickstart
+```
+samba:
+  image: joebiellik/samba-server
+
+  volumes:
+    # You must provide a Samba config file
+    - ./smb.conf:/config/smb.conf
+
+    # Shares
+    - ~/projects:/mnt/projects
+    - ~/videos:/mnt/videos:ro
+
+  ports:
+    - "137:137/udp"
+    - "138:138/udp"
+    - "139:139/tcp"
+    - "445:445/tcp"
+
+  environment:
+    - USERNAME=joe
+    - PASSWORD=samba
+```