From 2f39e3c94c1820018ced634e7d7527eecc64816c Mon Sep 17 00:00:00 2001
From: ache <ache@ache.one>
Date: Mon, 12 Feb 2018 03:41:40 +0100
Subject: Add a README

---
 README.md | 43 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

(limited to 'README.md')

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
 
-- 
cgit v1.2.3