summaryrefslogtreecommitdiff
path: root/plugins/atom/README.md
diff options
context:
space:
mode:
authorwyldphyre <craigreynolds@Claire.local>2015-02-27 11:05:05 +0800
committerncanceill <nicolas.canceill@ens-cachan.org>2015-06-12 00:17:22 +0200
commit81da07602c8e99548ffbe4d110d40ea5873f20fe (patch)
treeabb4e018f2392915c0ed5faac740f13bba1793ec /plugins/atom/README.md
parenta2d7d36e70abbdd1dc9b0f06e8841d4f74226195 (diff)
downloadzsh-81da07602c8e99548ffbe4d110d40ea5873f20fe.tar.gz
zsh-81da07602c8e99548ffbe4d110d40ea5873f20fe.tar.bz2
zsh-81da07602c8e99548ffbe4d110d40ea5873f20fe.zip
Added README.md file for atom plugin
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