From f1ee1c56816cccf33ddc7ee0a9fcbce7831ac274 Mon Sep 17 00:00:00 2001
From: Colin Hebert <hebert.colin@gmail.com>
Date: Wed, 4 Apr 2012 13:47:24 +0100
Subject: [PATCH] Add documentation for screen plugin

---
 plugins/screen/README.md | 31 +++++++++++++++++++++++++++++++
 plugins/screen/init.zsh  |  6 ------
 2 files changed, 31 insertions(+), 6 deletions(-)
 create mode 100644 plugins/screen/README.md

diff --git a/plugins/screen/README.md b/plugins/screen/README.md
new file mode 100644
index 00000000..d2cb3ada
--- /dev/null
+++ b/plugins/screen/README.md
@@ -0,0 +1,31 @@
+screen
+======
+
+Defines [GNU Screen][1] aliases and provides for auto launching it at start-up.
+
+Aliases
+-------
+
+ - `sl`, List sessions/socket directory
+ - `sn`, Start a new screen session
+ - `sr`, Attach to a screen session if possible, otherwise start a new one
+
+Settings
+--------
+
+### Auto-start
+
+Start a screen session automatically when a Zsh session is opened.
+
+To enable this feature, one line has to be added to the configuration file:
+
+    zstyle ':omz:plugin:screen' auto-start 'yes'
+
+Authors
+-------
+
+*The authors of this plugin should be contacted via the github bug tracker.*
+
+ - [Sorin Ionescu](/sorin-ionescu)
+
+[1]: http://www.gnu.org/software/screen/
diff --git a/plugins/screen/init.zsh b/plugins/screen/init.zsh
index 2528e833..2a789bcc 100644
--- a/plugins/screen/init.zsh
+++ b/plugins/screen/init.zsh
@@ -4,12 +4,6 @@
 # Authors:
 #   Sorin Ionescu <sorin.ionescu@gmail.com>
 #
-# Usage:
-#   To auto start it, add the following to zshrc:
-#
-#     # Auto launch GNU Screen at start-up.
-#     zstyle ':omz:plugin:screen' auto-start 'yes'
-#
 
 # Aliases
 alias sl="screen -list"