From 683517d16fa20b62e609372e322bf85465ca391f Mon Sep 17 00:00:00 2001
From: ache <ache@ache.one>
Date: Mon, 12 Feb 2018 03:34:01 +0100
Subject: Add a README

---
 README.md            |  42 ++++++++++++++++++++++++++++++++++++++++++
 images/example_1.png | Bin 0 -> 1073 bytes
 images/example_2.png | Bin 0 -> 1081 bytes
 images/example_3.png | Bin 0 -> 687 bytes
 4 files changed, 42 insertions(+)
 create mode 100644 images/example_1.png
 create mode 100644 images/example_2.png
 create mode 100644 images/example_3.png

diff --git a/README.md b/README.md
index 1b8bcdf..97bad79 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,45 @@
 # remark-line-input
 
+A [remark](https://github.com/remarkjs/remark/) plugin that parse Mardown syntax to add support for line input.
+
+
+## Syntax
+
+You can add a line input this way :
+
+```markdown
+[___Placeholder___]
+```
+
+Wich leads to :
+
+![Screenshot](https://raw.githubusercontent.com/arobase-che/remark-line-input/master/images/example_1.png)
+
+
+## Installation
+
+Not ready at the moment.
+
+
+## Configuration
+
+This plugin support custom HTML attributes :
+
+```markdown
+[___Password___]{type=password}
+```
+
+![Screenshot](https://raw.githubusercontent.com/arobase-che/remark-line-input/master/images/example_2.png)
+
+![Screenshot](https://raw.githubusercontent.com/arobase-che/remark-line-input/master/images/example_3.png)
+
+Or :
+
+```markdown
+[___Email___]{.form-elem onchange='check();' #login}
+```
+
+## Licence
+
+MIT
 
diff --git a/images/example_1.png b/images/example_1.png
new file mode 100644
index 0000000..f089895
Binary files /dev/null and b/images/example_1.png differ
diff --git a/images/example_2.png b/images/example_2.png
new file mode 100644
index 0000000..6f0a391
Binary files /dev/null and b/images/example_2.png differ
diff --git a/images/example_3.png b/images/example_3.png
new file mode 100644
index 0000000..136f753
Binary files /dev/null and b/images/example_3.png differ
-- 
cgit v1.2.3