summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-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