Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ yarn add react-native-enriched-markdown react-native-worklets remend
| Package | Version |
| -------------------------------- | ------------ |
| `react-native-enriched-markdown` | `0.4.0` |
| `react-native-worklets` | `0.8.0-rc.0` |
| `react-native-worklets` | `0.8.3` |
| `remend` | `1.2.2` |

---

## Required setup — Bundle Mode

`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).
`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).

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

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

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

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

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.

---

## Limitations

- **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.
- __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.

---

Expand Down
Loading
Loading