summaryrefslogtreecommitdiff
path: root/plugins/atom
diff options
context:
space:
mode:
authorRobby Russell <robby@planetargon.com>2015-06-14 21:46:41 -0700
committerRobby Russell <robby@planetargon.com>2015-06-14 21:46:41 -0700
commit78bbf7a6e52e7aabc82f22c43c9309a5f0ff1282 (patch)
tree6a2a6374797c0f303a293cd17547349a617c7404 /plugins/atom
parent9eaf51107f15011f73b39fb727895f65797edcbc (diff)
parenta7e79824f85a89cbcacbceab0277c9833dee4817 (diff)
downloadzsh-78bbf7a6e52e7aabc82f22c43c9309a5f0ff1282.tar.gz
zsh-78bbf7a6e52e7aabc82f22c43c9309a5f0ff1282.tar.bz2
zsh-78bbf7a6e52e7aabc82f22c43c9309a5f0ff1282.zip
Merge pull request #3809 from ncanceill/easymerge
Easy-to-Merge
Diffstat (limited to 'plugins/atom')
-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