summaryrefslogtreecommitdiff
path: root/plugins/atom/README.md
diff options
context:
space:
mode:
authorRamses Ladlani <ramses.ladlani@fishingcactus.com>2015-09-21 08:49:18 +0200
committerRamses Ladlani <ramses.ladlani@fishingcactus.com>2015-09-21 08:49:18 +0200
commit7576f856b915e6e02c5990cd7e221d7b9efbe44a (patch)
treebe3fe162edbc04946eea014a3612280d4909dc1e /plugins/atom/README.md
parent6e0fcf803fe00445c97861360d1b0806d8cc56b8 (diff)
parent918d26e7dbcb907e673df24242c9688cd89019b9 (diff)
downloadzsh-7576f856b915e6e02c5990cd7e221d7b9efbe44a.tar.gz
zsh-7576f856b915e6e02c5990cd7e221d7b9efbe44a.tar.bz2
zsh-7576f856b915e6e02c5990cd7e221d7b9efbe44a.zip
Merge remote-tracking branch 'robyrussel/master' into fix-atom_plugin_for_cygwin
Discarded all previous changes to atom plugin for easier review in next commit.
Diffstat (limited to 'plugins/atom/README.md')
-rw-r--r--plugins/atom/README.md12
1 files changed, 9 insertions, 3 deletions
diff --git a/plugins/atom/README.md b/plugins/atom/README.md
index 75d77a0ac..6350c647b 100644
--- a/plugins/atom/README.md
+++ b/plugins/atom/README.md
@@ -1,6 +1,8 @@
## atom
-Plugin for Atom, a cross platform text and code editor, available for Linux, Mac OS X, and Windows.
+This plugin makes "at" a useful function for invoking the Atom Editor.
+
+Originally by Github user [aforty](https://github.com/aforty) for OSX, modified to alias 'at' to 'atom' for Linux, since atom already works on the terminal for Linux, and calling 'at' in a non-OSX environment should still work.
### Requirements
@@ -10,8 +12,12 @@ Plugin for Atom, a cross platform text and code editor, available for Linux, Mac
* 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 directory, 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
+### Examples
+
+ * Open the current dir in atom: `at .`
+ * Open another dir in atom: `at path/to/folder`
+ * Open a file: `at filename.extension`