aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md43
-rw-r--r--images/example_1.pngbin0 -> 6715 bytes
-rw-r--r--images/example_2.pngbin0 -> 13037 bytes
3 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
diff --git a/images/example_1.png b/images/example_1.png
new file mode 100644
index 0000000..affaadc
--- /dev/null
+++ b/images/example_1.png
Binary files differ
diff --git a/images/example_2.png b/images/example_2.png
new file mode 100644
index 0000000..ebbbf64
--- /dev/null
+++ b/images/example_2.png
Binary files differ