Update README.md

1 files changed, 95 insertions, 52 deletions

diff --git a/README.md b/README.md
index a816f6c..8515d55 100644
--- a/README.md
+++ b/README.md
@@ -2,90 +2,111 @@
 
 This plugin adds support of custom attributes to Markdown syntax.
 
-For **security reasons**, this plugin uses [html-element-attributes](https://github.com/wooorm/html-element-attributes).  
+For **security reasons**, this plugin uses [html-element-attributes](https://github.com/wooorm/html-element-attributes).
 The use of JavaScript attributes (onload for example) is not allowed by default.
 
+
 ## Default Syntax
 
-Images : 
-```markdown
+Images :
+markdown
 ![alt](img){attrs} / ![alt](img){ height=50 }
-```
 
-Links   :
-```markdown
-[Hot babe with computer](https://rms.sexy){rel="external"}
-```
+
+Links :
+markdown
+[rms with a computer](https://rms.sexy){rel="external"}
+
+
+Autolink :
+markdown
+Email me at : <mailto:falseEmail@example.org>
+
 
 Header (Atx) :
-```markdown
+markdown
 ### This is a title
 {style="color:red;"}
-```
+
+or
+
+### This is a title {style="color:yellow;"}
+
+If option enableAtxHeaderInline is set to `true` (default value).
+
+
 Header :
-```markdown
+markdown
 This is a title
 ---------------
 {style="color: pink;"}
-```
+
 
 
 Emphasis :
-```markdown
+markdown
 Npm stand for *node*{style="color:red"} packet manager.
-```
 
-Strong  :
-```markdown
+
+Strong :
+markdown
 This is a **Unicorn**{awesome} !
-```
 
-Delete  :
-```markdown
+
+Delete :
+markdown
 Your problem is ~~at line 18~~{style="color: grey"}. My mistake, it's at line 14.
-```
 
-Code    :
-```markdown
+
+Code :
+markdown
 You can use the `fprintf`{language=c} function to format the output to a file.
-```
+
+
+Footnote (using [remark-footnotes](https://github.com/remarkjs/remark-footnotes)) :
+markdown
+This is a footnote[^ref]{style="opacity: 0.8;"}
+
+
+[^ref]: And the reference.
+
 
 ## rehype
 
 At the moment it aims is to be used with [rehype][rehype] only, using remark-rehype.
 
-```md
-[Hot babe with computer](https://rms.sexy){rel="external"}
-```
+md
+[rms with a computer](https://rms.sexy){rel=external}
 
-gives:
 
-```html
-<a href="https://rms.sexy" rel="external">Hot babe with computer</a>
-```
+produces:
+
+html
+<a href="https://rms.sexy" rel="external">rms with a computer</a>
+
 
 ## Installation
 
 [npm][npm]:
 
-```bash
+bash
 npm install remark-attr
-```
+
 
 ## Dependencies:
 
-```javascript
+javascript
 const unified = require('unified')
 const remarkParse = require('remark-parse')
 const stringify = require('rehype-stringify')
 const remark2rehype = require('remark-rehype')
 const remarkAttr = require('remark-attr')
 
-```
+
 
 ## Usage:
 
-```javascript
+javascript
 const testFile = `
 
 Here a test :
@@ -102,15 +123,15 @@ unified()
   .process( testFile, (err, file) => {
     console.log(String(file))
   } )
-```
+
 
 Output :
 
-```shell
+shell
 $ node index.js
 <p>Here a test :</p>
 <p><img src="https://ache.one/res/ache.svg" alt="ache avatar" height="100"></p>
-```
+
 
 ## API
 
@@ -124,44 +145,66 @@ The list of currently supported elements.
 
 `['link', 'atxHeading', 'strong', 'emphasis', 'deletion', 'code', 'setextHeading']`
 
+`['link', 'atxHeading', 'strong', 'emphasis', 'deletion', 'code', 'setextHeading', 'fencedCode', 'reference', 'footnoteCall', 'autoLink']`
+
 ##### Options
 
 ###### `options.allowDangerousDOMEventHandlers`
 
-Whether to allow the use of `on-*` attributes. They are depreciated and disabled by default for security reason. Its a boolean (default: `false`).
-If allowed, DOM event handlers will be added to the global scope.
+Whether to allow the use of `on-*` attributes. They are depreciated and disabled by default for security reasons. Its a boolean (default: `false`).
+If allowed, DOM event handlers will be added to the **global scope**.
 
 ###### `options.elements`
 
-The list of elements witch the attributes should be parsed. It's a list of string, a sub-list of `SUPPORTED_ELEMENTS`.
+The list of elements witch the attributes should be parsed.
+It's a list of string, a sub-list of `SUPPORTED_ELEMENTS`.
+If you are confident enough you can add the name of a tokenizer that isn't officialy supported but remember that it will not have been tested.
 
 ###### `options.extend`
 
 An object that extends the list of attributes supported for some elements.
 
-Example : 
+Example :
+
 
-```
 extend: {heading: ['original', 'quality', 'format', 'toc']}
-```
+
 
 With this configuration, if the scope permits it, 4 mores attributes will be supported for atxHeading elements.
 
 ###### `options.scope`
 
-A string with the value `"global"` or `"specific"` or `"extented"` or `"none"` or `"every"`.
+A string with the value `global` or `specific` or `extented` or `none` or `every`.
+
+ - `none` will disable the plugin.
+ - `global` will activate only the global attributes.
+ - `specific` will activate global and specific attributes.
+ - `extended` will add personalized tags for some elements.
+ - `permissive` or `every` will allow every attributes (except dangerous one) on every elements supported.
+
+###### `options.enableAtxHeaderInline`
+
+Whether to allow atx headers with attributes on the same line.
+
+~~~md
+### This is a title {style="color:yellow;"}
+~~~
+
+## How does it works ?
+
+This plugin extend the syntax of [remark-parse][remark-parse] by replacing old tokenizers by new one.
+The new tokenizers functions re-use the old tokenizers and [md-attr-parser][md-attr-parser] to parse the extended syntax.
+
+So `option.SUPPORTED_ELEMENTS` are the names of the tokenizers and neither arbitrary names nor HTML tag names.
+Here is the [related documentation][doc].
 
- - `"none"` will disable the plugin.
- - `"global"` will activate only the global attributes.
- - `"specific"` will activate global and specific attributes.
- - `"extended"` will add personalized tags for some elements.
- - `"permissive"` or `"every"` will allow every attributes (except dangerous one) on every elements supported.
 
 ## License
 
 Distributed under a MIT license.
 
 [npm]: https://www.npmjs.com/package/remark-attr
-
 [rehype]: https://github.com/wooorm/rehype
-
+[remar-parse]: https://github.com/remarkjs/remark/tree/master/packages/remark-parse
+[md-attr-parser]: https://github.com/arobase-che/md-attr-parser
+[doc]: https://github.com/remarkjs/remark/tree/master/packages/remark-parse#extending-the-parser