Skip to content

Commit

Permalink
improved the README, closes #1
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonathon Kelly committed Mar 14, 2016
1 parent 1ba9606 commit 9d2f731
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 1 deletion.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
# react-markdown-renderer

[![Build Status](https://travis-ci.org/InsidersByte/react-markdown-renderer.svg)](https://travis-ci.org/InsidersByte/react-markdown-renderer)
[![Dependency Status](https://david-dm.org/insidersbyte/react-markdown-renderer.svg)](https://david-dm.org/insidersbyte/react-markdown-renderer)
[![peerDependency Status](https://david-dm.org/insidersbyte/react-markdown-renderer/peer-status.svg)](https://david-dm.org/insidersbyte/react-markdown-renderer#info=peerDependencies)
[![devDependency Status](https://david-dm.org/insidersbyte/react-markdown-renderer/dev-status.svg)](https://david-dm.org/insidersbyte/react-markdown-renderer#info=devDependencies)

Simple React component that renders Markdown

## Installing

```bash
npm install react-markdown-renderer
```

## Usage

```js
import React from 'react';
import ReactDOM from 'react-dom';
import MarkdownRenderer from 'react-markdown-renderer';

const markdown = '# This is an H1 \n## This is an H2 \n###### This is an H6';

ReactDOM.render(
<MarkdownRenderer markdown={markdown} />,
document.getElementById('content')
);
```

## Props

* markdown (*string*) - the raw markdown that will be converted to html (**required**)
* className (*string*) - css classes to add to the component (default: '').

## Contributing

Contributions are very welcome! Please note that by submitting a pull request for this project, you agree to license your contribution under the [MIT License](https://github.com/insidersbyte/react-markdown-renderer/blob/master/LICENSE) to this project.

## License

Published under the [MIT License](https://github.com/insidersbyte/react-markdown-renderer/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "react-markdown-renderer",
"version": "0.1.1",
"description": "Render markdown as a React component",
"description": "Simple React component that renders Markdown",
"main": "lib/index.js",
"files": [
"lib"
Expand Down

0 comments on commit 9d2f731

Please sign in to comment.