[Breaking Change] Default export is now a React HOC

See the README for updated usage instructions.

README.md

@@ -16,44 +16,53 @@ Requires React >= 0.14.
 
 ## Usage
 
-The default export function signature:
-
-```js
-compiler(markdown: string, options: object?)
-```
+`markdown-to-jsx` exports a React component by default for easy JSX composition (since version v5):
 
 ES6-style usage:
 
-```js
-import compiler from 'markdown-to-jsx';
+```jsx
+import Markdown from 'markdown-to-jsx';
 import React from 'react';
 import {render} from 'react-dom';
 
-render(compiler('# Hello world!'), document.body);
+render((
+    <Markdown>
+        # Hello world!
+    </Markdown>
+), document.body);
+
+/*
+    renders:
+
+    <h1>Hello world!</h1>
+ */
 ```
 
 Override a particular HTML tag's output:
 
 ```jsx
-import compiler from 'markdown-to-jsx';
+import Markdown from 'markdown-to-jsx';
 import React from 'react';
 import {render} from 'react-dom';
 
 // surprise, it's a div instead!
 const MyParagraph = ({children, ...props}) => (<div {...props}>{children}</div>);
 
-render(
-    compiler('# Hello world!', {
-        overrides: {
-            h1: {
-                component: MyParagraph,
-                props: {
-                    className: 'foo',
+render((
+    <Markdown
+        options={{
+            overrides: {
+                h1: {
+                    component: MyParagraph,
+                    props: {
+                        className: 'foo',
+                    },
                 },
             },
-        },
-    }), document.body
-);
+        }}>
+        # Hello world!
+    </Markdown>
+), document.body);
 
 /*
     renders:
@@ -75,4 +84,28 @@ Depending on the type of element, there are some props that must be preserved to
 
 Any conflicts between passed `props` and the specific properties above will be resolved in favor of `markdown-to-jsx`'s code.
 
+## Using the compiler directly
+
+If desired, the compiler function is a "named" export on the `markdown-to-jsx` module:
+
+```jsx
+import {compiler} from 'markdown-to-jsx';
+import React from 'react';
+import {render} from 'react-dom';
+
+render(compiler('# Hello world!'), document.body);
+
+/*
+    renders:
+
+    <h1>Hello world!</h1>
+ */
+```
+
+It accepts the following arguments:
+
+```js
+compiler(markdown: string, options: object?)
+```
+
 MIT

index.js

@@ -1,4 +1,4 @@
-import React from 'react';
+import React, {PropTypes} from 'react';
 import get from 'lodash.get';
 import unified from 'unified';
 import parser from 'remark-parse';
@@ -400,7 +400,7 @@ function coalesceInlineHTML(ast) {
     return ast.children.forEach(coalescer);
 }
 
-export default function markdownToJSX(markdown, {overrides = {}} = {}) {
+export function compiler(markdown, {overrides = {}} = {}) {
     let definitions;
     let footnotes;
 
@@ -610,4 +610,22 @@ export default function markdownToJSX(markdown, {overrides = {}} = {}) {
     }
 
     return jsx;
-}
+};
+
+/**
+ * A simple HOC for easy React use. Feed the markdown content as a direct child
+ * and the rest is taken care of automatically.
+ *
+ * @param  {String}   options.children   must be a string
+ * @param  {Object}   options.options    markdown-to-jsx options (arg 2 of the compiler)
+ *
+ * @return {ReactElement} the compiled JSX
+ */
+const Component = ({children, options, ...props}) => compiler(children, options);
+
+Component.propTypes = {
+    children: PropTypes.string.isRequired,
+    options: PropTypes.object,
+};
+
+export default Component;