dca429557aef7b700ae2f1088115a707af78a31b

Author
Ben Klein <robobenklein@gmail.com>
Committer
Ben Klein <robobenklein@gmail.com>
Date

Message

Make Readme much clearer and explain edits.

Also added some examples, but those should be mostly self-explanatory.

Diff

 1diff --git a/plugins/atom/README.md b/plugins/atom/README.md
 2index 75d77a0ac1c3732be4dbab1b4062e4f8e1d315fc..6350c647b029ef0ca2416c6dcfe976a63e1d1534 100644
 3--- a/plugins/atom/README.md
 4+++ b/plugins/atom/README.md
 5@@ -1,6 +1,8 @@
 6 ## atom
 7 
 8-Plugin for Atom, a cross platform text and code editor, available for Linux, Mac OS X, and Windows.
 9+This plugin makes "at" a useful function for invoking the Atom Editor.
10+
11+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.
12 
13 ### Requirements
14 
15@@ -10,8 +12,12 @@ Plugin for Atom, a cross platform text and code editor, available for Linux, Mac
16 
17  * If `at` command is called without an argument, launch Atom
18 
19- * If `at` is passed a directory, `cd` to it and open it in Atom
20+ * If `at` is passed a directory, open it in Atom
21 
22  * If `at` is passed a file, open it in Atom
23 
24- * if `att` command is called, it is equivalent to `at .`, opening the current folder in Atom
25+### Examples
26+
27+ * Open the current dir in atom: `at .`
28+ * Open another dir in atom: `at path/to/folder`
29+ * Open a file: `at filename.extension`