1 files changed, 18 insertions, 0 deletions
diff --git a/modules/minwinsvc/README.md b/modules/minwinsvc/README.md
new file mode 100644
index 0000000000..260dceeac3
--- /dev/null
+++ b/modules/minwinsvc/README.md
@@ -0,0 +1,18 @@
+### Minimal windows service stub
+
+Programs designed to run from most *nix style operating systems
+can import this package to enable running programs as services without modifying
+them.
+
+```
+import _ "github.com/kardianos/minwinsvc"
+```
+
+If you need more control over the exit behavior, set
+```
+minwinsvc.SetOnExit(func() {
+	// Do something.
+	// Within 10 seconds call:
+	os.Exit(0)
+})
+```