summaryrefslogtreecommitdiff
path: root/plugins/atom/README.md
diff options
context:
space:
mode:
authorDawid Ferenczy <dawid@ferenczy.cz>2015-08-25 16:34:04 +0200
committerDawid Ferenczy <dawid@ferenczy.cz>2015-08-25 16:34:04 +0200
commit18ef1ee6481dbeca4fbecf3de627f946860ffd5a (patch)
treecb07e72538c470bb486596d955c7912c5b05e23e /plugins/atom/README.md
parenteafd5f325208421b82a770e57441dd1063eb5745 (diff)
parent192de6bcffb0294e19f4203f6f7dc1a7f3e427be (diff)
downloadzsh-18ef1ee6481dbeca4fbecf3de627f946860ffd5a.tar.gz
zsh-18ef1ee6481dbeca4fbecf3de627f946860ffd5a.tar.bz2
zsh-18ef1ee6481dbeca4fbecf3de627f946860ffd5a.zip
Merge remote-tracking branch 'robbyrussell/master'
Diffstat (limited to 'plugins/atom/README.md')
-rw-r--r--plugins/atom/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/atom/README.md b/plugins/atom/README.md
new file mode 100644
index 000000000..75d77a0ac
--- /dev/null
+++ b/plugins/atom/README.md
@@ -0,0 +1,17 @@
+## atom
+
+Plugin for Atom, a cross platform text and code editor, available for Linux, Mac OS X, and Windows.
+
+### Requirements
+
+ * [Atom](https://atom.io/)
+
+### Usage
+
+ * If `at` command is called without an argument, launch Atom
+
+ * If `at` is passed a directory, `cd` to it and open it in Atom
+
+ * If `at` is passed a file, open it in Atom
+
+ * if `att` command is called, it is equivalent to `at .`, opening the current folder in Atom