Skip to content

Commit

Permalink
Update docs for ESM
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Aug 13, 2021
1 parent 28d4c75 commit c613efd
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ Markdown component for React using [**remark**][remark].

## Install

This package is [ESM only](https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c):
Node 12+ is needed to use it and it must be `import`ed instead of `require`d.

[npm][]:

```sh
Expand Down Expand Up @@ -84,6 +87,9 @@ ReactDom.render(

## API

This package exports the following identifier: `uriTransformer`.
The default export is `ReactMarkdown`.

### `props`

* `children` (`string`, default: `''`)\
Expand Down

0 comments on commit c613efd

Please sign in to comment.