Skip to content

Commit

Permalink
Correct small error in README
Browse files Browse the repository at this point in the history
  • Loading branch information
ZxMYS committed Aug 5, 2018
1 parent d51f97c commit 0b7dfd1
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ It calls twemoji.parse() to convert emoji characters to Twemoji images.
## Install

```shell
yarn install react-twemoji
yarn add react-twemoji
```

or, if you use npm,

```shell
npm install react-twemoji
```

## Usage
Expand Down Expand Up @@ -33,12 +39,12 @@ It outputs following HTML to DOM,
</div>
```

## Props
### Props

| Name | Type | Default | Description|
|:---- |:---- |:---- |:----|
| `options` | `Object` | `{}` | `twemoji.parse` options |
| `noWrapper` | `Boolean` | `false` | When set to `true`, Twemoji will not render a wrapping `div` to contain children |
| `noWrapper` | `Boolean` | `false` | When it is `true`, Twemoji will not render a wrapping `div` to contain children |

### Run example

Expand Down

0 comments on commit 0b7dfd1

Please sign in to comment.