summaryrefslogtreecommitdiff
path: root/plugins/sublime/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/sublime/README.md')
-rw-r--r--plugins/sublime/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/plugins/sublime/README.md b/plugins/sublime/README.md
new file mode 100644
index 000000000..e1e666f05
--- /dev/null
+++ b/plugins/sublime/README.md
@@ -0,0 +1,19 @@
+## sublime
+
+Plugin for Sublime Text, a cross platform text and code editor, available for Linux, Mac OS X, and Windows.
+
+### Requirements
+
+ * [Sublime Text](http://www.sublimetext.com/)
+
+### Usage
+
+ * If `st` command is called without an argument, launch Sublime Text
+
+ * If `st` is passed a directory, `cd` to it and open it in Sublime Text
+
+ * If `st` is passed a file, open it in Sublime Text
+
+ * If `stt` command is called, it is equivalent to `st .`, opening the current folder in Sublime Text
+
+ * If `sst` command is called, it is like `sudo st`, opening the file or folder in Sublime Text. Useful for editing system protected files. \ No newline at end of file