aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorache <ache@ache.one>2018-02-12 03:41:40 +0100
committerache <ache@ache.one>2018-02-12 03:41:40 +0100
commit2f39e3c94c1820018ced634e7d7527eecc64816c (patch)
tree195dfdec630a99948aa551f1c331548a095860e8 /README.md
parentoups bad test content (diff)
Add a READMEHEADmaster
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 42 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9f10c02..a6e499b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,44 @@
-# remark-mermaid-simple
+# remark-multiple-choise
+A [remark](https://github.com/remarkjs/remark/) plugin that parse Mardown syntax to add support for line input.
+
+
+## Syntax
+
+You can add a multiple chioise question this way :
+
+```markdown
+ - [x] ! False
+ - [ ] ~ None
+ - [x] = True`);
+```
+
+Wich leads to :
+
+![Screenshot](https://raw.githubusercontent.com/arobase-che/remark-multiple-choice/master/images/example_1.png)
+
+
+
+
+## Example
+
+```markdown
+Albert NOVEL was the inventor of the :
+
+ - [ ] = Dynamite
+ - [ ] ! Nichrome
+ - [ ] ! Battery
+ - [ ] ! Hot air balloon
+```
+
+![Screenshot](https://raw.githubusercontent.com/arobase-che/remark-multiple-choice/master/images/example_2.png)
+
+
+## Installation
+
+Not ready at the moment.
+
+## Licence
+
+MIT