summaryrefslogtreecommitdiff
path: root/plugins/marktext/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/marktext/README.md')
-rw-r--r--plugins/marktext/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/plugins/marktext/README.md b/plugins/marktext/README.md
new file mode 100644
index 000000000..71d287451
--- /dev/null
+++ b/plugins/marktext/README.md
@@ -0,0 +1,17 @@
+## marktext
+
+Plugin for MarkText, a previewer for Markdown files on Mac OS X
+
+### Requirements
+
+ * [MarkText](https://github.com/marktext/marktext)
+
+### Usage
+
+ * If `marktext` is called without an argument, open MarkText
+
+ * If `marktext` is passed a file, open it in MarkText
+
+### Credits
+
+ * just copied from plugins/marked2, all credits to marked2 plugin author