Merge branch 'master' into develop

# Conflicts:
#	example/App.js
#	example/package.json
#	package.json

Author: mientjan

README.md

@@ -1,14 +1,29 @@
-# React Native Markdown Renderer [![npm version](https://badge.fury.io/js/react-native-markdown-renderer.svg)](https://badge.fury.io/js/react-native-markdown-renderer)
+# React Native Markdown Renderer [![npm version](https://badge.fury.io/js/react-native-markdown-renderer.svg)](https://badge.fury.io/js/react-native-markdown-renderer) [![Known Vulnerabilities](https://snyk.io/test/github/mientjan/react-native-markdown-renderer/badge.svg)](https://snyk.io/test/github/mientjan/react-native-markdown-renderer)
 
 Is a 100% compatible CommonMark renderer, a react-native markdown renderer done right. This is __not__
 a web-view markdown renderer but a renderer that uses native components for all its elements. These components can be overwritten when needed as seen in the examples.
 
-To give a summary of the supported syntax react-native-markdown-renderer supports.
+### Future releases
+##### v2.1.0
+ - We are going to switch to a type based rule system instead of a html tags. Rules are currently 
+ based off html tags "a,h1,h2,h3,h4,ul,li etc." this will change to "anchor, heading1, bullet_list, bullet_list_item" 
+ This makes it a lot easier to add extra syntax features through plugins. 
+ 
+
+### Quick links
+ - [Documentation](https://github.com/mientjan/react-native-markdown-renderer/wiki/)
+ - [Examples](https://github.com/mientjan/react-native-markdown-renderer/wiki/Examples)
+ - [Example App](https://github.com/mientjan/react-native-markdown-renderer/wiki/ExampleApp)
+ 
+
+### Syntax Support
 
+To give a summary of the supported syntax react-native-markdown-renderer supports.
+ 
  - Tables
  - Heading 1 > 6
  - Horizontal Rules
- - Typographic replacements
+ - Typographic Replacements
  - Emphasis ( **bold**, *italic*, ~~strikethrough~~ )
  - Blockquotes
  - Lists
@@ -20,21 +35,45 @@ To give a summary of the supported syntax react-native-markdown-renderer support
  - Syntax highlighting
  - Links
  - Images
- - Plugins for extra syntax support, [see plugins](https://www.npmjs.com/browse/keyword/markdown-it-plugin). Because this markdown-renderer uses markdown-it as its base it also supports all its plugins and subsequent extra language support.
+ - Plugins for **extra** syntax support, [see plugins](https://www.npmjs.com/browse/keyword/markdown-it-plugin). 
+ Because this markdown-renderer uses markdown-it as its base it also supports all its plugins and 
+ subsequent extra language support.
+ 
+### Plugins, Extending Markdown (common mark A+) language support
+This renderer, supports the ability extend the current CommonMark A+ spec. 
+
+For example:
 
+ - checkboxes: [ ] Not Checked [x] Checked https://www.npmjs.com/package/markdown-it-checkbox
+ - Video Embeds: ```@[youtube](dQw4w9WgXcQ)``` https://www.npmjs.com/package/markdown-it-video
+ 
+And a lot more, the list of community created plugins to extends the language are endless. But be 
+**carefull** add a plugin is easy, creating a rule for it is not. Currently the astRenderer and rules 
+are based off html tags. This makes it especially hard when adding stuff like checkbox or Video Embeds 
+that are grouped under input, label and a tag.
 
-### tested on:
+**Version 2.1.0** will switch this around and move the rules from tags to type. So a ```* list``` was a "li" 
+in the rules becomes a "bullet_list_item".
+
+Checkbox was a "input" with no wrapper and will now move to "checkbox". This change will help to make support 
+for plugins a lot easier   
+
+
+### Tested on:
 
 | [] | react | react-native |
 | ---- | ---- | ------- |
 | v | 16.0.0-alpha.12 | 0.45.1 |
 | v | 16.0.0-alpha.6 | 0.44.0 |
-| v | ^15.6.1 | ^0.46.4 |
+| x | 15.x | ^0.46.4 |
+
+``` // react 15 seems to break with expo.```
 
-### todo
- - add styleSheet support
+### Todo
+ - ~~add styleSheet support~~
+ - ~~add plugin support~~
+ - ~~add support for seperate rules~~
  - add styleSheet inheritance support
- - ~~adding plugin support~~
 
 ### How to:
 
@@ -47,92 +86,10 @@ npm install -S react-native-markdown-renderer
 yarn add react-native-markdown-renderer
 ```
 
-### Example:
-##### Simple example
-```js
-
-import react from 'react';
-import {View, PureComponent} from 'react-native';
-import Markdown from 'react-native-markdown-renderer';
-
-const copy = `# h1 Heading 8-)
-
-| Option | Description |
-| ------ | ----------- |
-| data   | path to data files to supply the data that will be passed into templates. |
-| engine | engine to be used for processing templates. Handlebars is the default. |
-| ext    | extension to be used for dest files. |
-`;
-
-export default class Page extends PureComponent {
-
-  static propTypes = {};
-  static defaultProps = {};
-
-  render() {
-
-    return (
-    	<Markdown>{copy}</Markdown>
-    );
-  }
-}
-```
-
-##### If you want to use your own native elements and styling, and want to add extra plugins:
-```js
-
-import react from 'react';
-import {View, PureComponent, Text} from 'react-native';
-import Markdown, { AstRenderer, defaultRenderFunctions, PluginContainer, blockPlugin} from 'react-native-markdown-renderer';
-
-const copy = `# h1 Heading 8-)
-
-| Option | Description |
-| ------ | ----------- |
-| data   | path to data files to supply the data that will be passed into templates. |
-| engine | engine to be used for processing templates. Handlebars is the default. |
-| ext    | extension to be used for dest files. |
-
-[block]
-I'm in a block
-[/block]
-`;
-
-/**
- * i'm overriding the default h1 render function.
- */
-const renderer = new AstRenderer({
-  ...defaultRenderFunctions,
-  h1: (node, children, parents) => {
-    return <Text style={{backgroundColor: 'red'}}>{children}</Text>;
-  },
-  // added custom block element defined by plugin
-  block: (node, children, parents) => {
-  	return <Text style={{backgroundColor: 'green'}}>{children}</Text>;
-  }
-});
-
-export default class Page extends PureComponent {
-
-  static propTypes = {};
-  static defaultProps = {};
-
-  render() {
-
-  	const plugins = [
-  	  new PluginContainer(blockPlugin, 'block', {})
-  	];
-
-    return (
-    	<Markdown renderer={renderer} plugins={plugins}>{copy}</Markdown>
-    );
-  }
-}
-```
+See [WIKI](https://github.com/mientjan/react-native-markdown-renderer/wiki/) for examples and documentation
 
 ---
 
-
 # Syntax Support
 
 __Advertisement :)__