aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorache <ache@ache.one>2018-02-11 22:37:20 +0100
committerache <ache@ache.one>2018-02-11 22:37:20 +0100
commit03e076d76f3ff3e2ac33c86a715b47be2b5f1474 (patch)
tree2b6abc482601592887cbceddef0c6ab322246f32
parentBetter parsing (diff)
Add a README
-rw-r--r--README.md39
1 files changed, 39 insertions, 0 deletions
diff --git a/README.md b/README.md
index b1a339c..45e96ca 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,42 @@
# remark-text-input
+A [remark](https://github.com/remarkjs/remark/) plugin that parse Mardown syntax to add support for text area.
+
+## Syntax
+
+You can add a text area this way :
+
+```markdown
+[______
+Some text.
+
+This is the content of the text area.
+_____]
+```
+
+Wich leads to :
+
+![img]()
+
+
+## Installation
+
+Not ready at the moment.
+
+
+## Configuration
+
+This plugin support custom HTML attributes :
+
+```markdown
+[____
+Here
+some
+text
+_____]{.row=5 .cols=10}
+```
+
+## Licence
+
+MIT