Added README.md file for atom plugin

2015-02-27 11:05:05 +08:00 · 2015-02-27 11:05:05 +08:00 · 81da07602c
commit 81da07602c
parent a2d7d36e70
1 changed files with 17 additions and 0 deletions
--- a/plugins/atom/README.md
+++ 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