Skip to content

Commit 1ea3f94

Browse files
committed
chore: update README.md
1 parent b17eaee commit 1ea3f94

File tree

1 file changed

+29
-14
lines changed

1 file changed

+29
-14
lines changed

README.md

Lines changed: 29 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,10 @@ npm install @expensify/react-native-live-markdown react-native-worklets expensif
2020
npx expo install @expensify/react-native-live-markdown react-native-worklets expensify-common html-entities@2.5.3
2121
```
2222

23-
React Native Live Markdown requires [react-native-worklets](https://github.com/software-mansion/react-native-reanimated/tree/main/packages/react-native-worklets) 0.6.0 or newer as well as [expensify-common](https://github.com/Expensify/expensify-common) 2.0.115 and [html-entities](https://github.com/mdevils/html-entities) 2.5.3 exactly if using the default built-in ExpensiMark parser.
23+
React Native Live Markdown requires [react-native-worklets](https://github.com/software-mansion/react-native-reanimated/tree/main/packages/react-native-worklets) 0.7.0 or newer as well as [expensify-common](https://github.com/Expensify/expensify-common) 2.0.115 and [html-entities](https://github.com/mdevils/html-entities) 2.5.3 exactly if using the default built-in ExpensiMark parser.
24+
25+
> [!IMPORTANT]
26+
> Please follow the `react-native-worklets` [Getting Started](https://docs.swmansion.com/react-native-worklets/docs/#react-native-community-cli) guide to avoid issues.
2427
2528
Then, install the iOS dependencies with CocoaPods:
2629

@@ -180,26 +183,38 @@ Currently, `react-native-live-markdown` supports only [ExpensiMark](https://gith
180183
`MarkdownTextInput` inherits all props of React Native's `TextInput` component as well as introduces the following properties:
181184

182185
| Prop | Type | Default | Note |
183-
| --------------- | ------------------------------------ | ----------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
186+
|-----------------|--------------------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
184187
| `parser` | `(value: string) => MarkdownRange[]` | `undefined` | A function that parses the current value and returns an array of ranges. |
185188
| `markdownStyle` | `MarkdownStyle` | `undefined` | Adds custom styling to Markdown text. The provided value is merged with default style object. See [Styling](https://github.com/expensify/react-native-live-markdown/blob/main/README.md#styling) for more information. |
186189

187190
## Compatibility
188191

189192
`react-native-live-markdown` supports only latest React Native minor releases with the New Architecture enabled.
190193

191-
| @expensify/react-native-live-markdown | 0.73 | 0.74 | 0.75 | 0.76 | 0.77 | 0.78 | 0.79 | 0.80 | 0.81 |
192-
| :-----------------------------------: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: | :--: |
193-
| 0.1.304+ ||||||||||
194-
| 0.1.297 – 0.1.303 ||||||||||
195-
| 0.1.260 – 0.1.296 ||||||||||
196-
| 0.1.256 – 0.1.259 ||||||||||
197-
| 0.1.248 – 0.1.255 ||||||||||
198-
| 0.1.235 – 0.1.247 ||||||||||
199-
| 0.1.141 – 0.1.234 ||||||||||
200-
| 0.1.129 – 0.1.140 ||||||||||
201-
| 0.1.122 – 0.1.128 ||||||||||
202-
| 0.1.15 – 0.1.121 ||||||||||
194+
### React Native compatibility
195+
196+
| | 0.73 | 0.74 | 0.75 | 0.76 | 0.77 | 0.78 | 0.79 | 0.80 | 0.81 | 0.82 | 0.83 |
197+
|:-----------------:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|:----:|
198+
| 0.1.321+ ||||||||||||
199+
| 0.1.304 - 0.1.320 ||||||||||||
200+
| 0.1.297 – 0.1.303 ||||||||||||
201+
| 0.1.260 – 0.1.296 ||||||||||||
202+
| 0.1.256 – 0.1.259 ||||||||||||
203+
| 0.1.248 – 0.1.255 ||||||||||||
204+
| 0.1.235 – 0.1.247 ||||||||||||
205+
| 0.1.141 – 0.1.234 ||||||||||||
206+
| 0.1.129 – 0.1.140 ||||||||||||
207+
| 0.1.122 – 0.1.128 ||||||||||||
208+
| 0.1.15 – 0.1.121 ||||||||||||
209+
210+
211+
### `react-native-worklets` compatibility
212+
213+
| | 0.6.x | 0.7.x |
214+
|:-----------------:|:-----:|:-----:|
215+
| 0.1.321+ |||
216+
| 0.1.308 – 0.1.320 |||
217+
203218

204219
## License
205220

0 commit comments

Comments
 (0)