Skip to content

Commit d0f57da

Browse files
authored
chore: update readme and bump worklets (#7)
* chore: update readme and bump worklets * chore: bump react-native and worklets * fix: jest preset
1 parent 1fdb732 commit d0f57da

6 files changed

Lines changed: 980 additions & 2265 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,14 +31,14 @@ yarn add react-native-enriched-markdown react-native-worklets remend
3131
| Package | Version |
3232
| -------------------------------- | ------------ |
3333
| `react-native-enriched-markdown` | `0.4.0` |
34-
| `react-native-worklets` | `0.8.0-rc.0` |
34+
| `react-native-worklets` | `0.8.3` |
3535
| `remend` | `1.2.2` |
3636

3737
---
3838

3939
## Required setup — Bundle Mode
4040

41-
`react-native-streamdown` runs markdown processing on a worklet thread using **Bundle Mode** from `react-native-worklets`. This requires extra configuration steps from the [official Bundle Mode setup guide](https://docs.swmansion.com/react-native-worklets/docs/bundleMode/setup/). Make sure to complete these steps before continuing. For a real-world reference of an app configured with Bundle Mode, check out the [Bundle Mode Showcase App](https://github.com/software-mansion-labs/Bundle-Mode-showcase-app).
41+
`react-native-streamdown` runs markdown processing on a worklet thread using __Bundle Mode__ from `react-native-worklets`. This requires extra configuration steps from the [official Bundle Mode setup guide](https://docs.swmansion.com/react-native-worklets/docs/bundleMode/setup/). Make sure to complete these steps before continuing. For a real-world reference of an app configured with Bundle Mode, check out the [Bundle Mode Showcase App](https://github.com/software-mansion-labs/Bundle-Mode-showcase-app).
4242

4343
### 1. `babel.config.js` — configure Worklets Babel plugin
4444

@@ -179,16 +179,16 @@ import { StreamdownText } from 'react-native-streamdown';
179179

180180
The `example/` directory in this repository contains a fully working demo app that shows:
181181

182-
- **Streaming Markdown Simulator** — streams a sample markdown document token-by-token to demonstrate rendering quality and the `streamingAnimation` effect
183-
- **LLM Streaming Demo** — connects to the OpenAI Chat Completions API via SSE and renders the response live using `StreamdownText`
182+
- __Streaming Markdown Simulator__ — streams a sample markdown document token-by-token to demonstrate rendering quality and the `streamingAnimation` effect
183+
- __LLM Streaming Demo__ — connects to the OpenAI Chat Completions API via SSE and renders the response live using `StreamdownText`
184184

185185
It is a practical reference for the full Bundle Mode setup (Babel, Metro, `package.json` flags) and for how to wire `StreamdownText` into a real streaming UI.
186186

187187
---
188188

189189
## Limitations
190190

191-
- **CommonMark only**`StreamdownText` currently renders using the `commonmark` flavour of `react-native-enriched-markdown`. GitHub Flavored Markdown (GFM) support is planned for a future release.
191+
- __CommonMark only__`StreamdownText` currently renders using the `commonmark` flavour of `react-native-enriched-markdown`. GitHub Flavored Markdown (GFM) support is planned for a future release.
192192

193193
---
194194

0 commit comments

Comments
 (0)