From 62a645d16202ef0b15e942fb410d6febc7bad20f Mon Sep 17 00:00:00 2001 From: ache Date: Mon, 30 Apr 2018 14:36:04 +0200 Subject: Add information to install and use --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 882cbd4..e4c1d71 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,42 @@ Wich leads to : ## Installation -Not ready at the moment. +Easy as npm i : +```shell +npm install remark-text-input +``` + + +## Installation + +An example of code : + +```js +const unified = require('unified') +const remarkParse = require('remark-parse') +const stringify = require('rehype-stringify') +const remark2rehype = require('remark-rehype') + +const textInput = require('remark-text-input') + +const testFile = `This is a text area : + +[_____ +A editable text here +_____]` + +unified() + .use(remarkParse) + .use(textInput) + .use(remark2rehype) + .use(stringify) + .process( testFile, (err, file) => { + console.log(String(file)); + } ); +``` + +In the file, a text-area should be preceded by an empty line. ## Configuration -- cgit v1.2.3