Skip to content

Commit 6351f9b

Browse files
authored
chore: bump remend to 1.3.0 and update README (#9)
1 parent f25ccb5 commit 6351f9b

3 files changed

Lines changed: 21 additions & 14 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It processes raw, incomplete markdown (as it streams token-by-token from an LLM)
1010

1111
- Renders incomplete streaming markdown correctly — no visual glitches mid-stream
1212
- Background thread processing via `react-native-worklets` Bundle Mode
13-
- Inline LaTeX support (`$...$`) with streaming completion — applied automatically, no configuration needed (we've also opened a [PR to add this directly to remend](https://github.com/vercel/streamdown/pull/446))
13+
- Inline LaTeX support (`$...$`) with streaming completion — applied automatically, no configuration needed
1414
- CommonMark rendering (headers, bold, italic, inline code, fenced code blocks, links, images) powered by `react-native-enriched-markdown` with built-in `streamingAnimation`
1515
- Customizable via `remendConfig`
1616

@@ -28,17 +28,17 @@ yarn add react-native-streamdown
2828
yarn add react-native-enriched-markdown react-native-worklets remend
2929
```
3030

31-
| Package | Version |
32-
| -------------------------------- | ------------ |
33-
| `react-native-enriched-markdown` | `0.4.0` |
34-
| `react-native-worklets` | `0.8.3` |
35-
| `remend` | `1.2.2` |
31+
| Package | Version |
32+
| -------------------------------- | ------- |
33+
| `react-native-enriched-markdown` | `0.4.0` |
34+
| `react-native-worklets` | `0.8.3` |
35+
| `remend` | `1.3.0` |
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

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484
"react-native-sse": "1.2.1",
8585
"react-native-worklets": "0.8.3",
8686
"release-it": "^19.0.4",
87-
"remend": "1.2.2",
87+
"remend": "1.3.0",
8888
"turbo": "^2.5.6",
8989
"typescript": "^5.9.2"
9090
},
@@ -93,7 +93,7 @@
9393
"react-native": "*",
9494
"react-native-enriched-markdown": "0.4.0",
9595
"react-native-worklets": ">=0.8.3",
96-
"remend": "1.2.2"
96+
"remend": "1.3.0"
9797
},
9898
"workspaces": [
9999
"example"

yarn.lock

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10309,15 +10309,15 @@ __metadata:
1030910309
react-native-sse: "npm:1.2.1"
1031010310
react-native-worklets: "npm:0.8.3"
1031110311
release-it: "npm:^19.0.4"
10312-
remend: "npm:1.2.2"
10312+
remend: "npm:1.3.0"
1031310313
turbo: "npm:^2.5.6"
1031410314
typescript: "npm:^5.9.2"
1031510315
peerDependencies:
1031610316
react: "*"
1031710317
react-native: "*"
1031810318
react-native-enriched-markdown: 0.4.0
1031910319
react-native-worklets: ">=0.8.3"
10320-
remend: 1.2.2
10320+
remend: 1.3.0
1032110321
languageName: unknown
1032210322
linkType: soft
1032310323

@@ -10553,6 +10553,13 @@ __metadata:
1055310553
languageName: node
1055410554
linkType: hard
1055510555

10556+
"remend@npm:1.3.0":
10557+
version: 1.3.0
10558+
resolution: "remend@npm:1.3.0"
10559+
checksum: 10c0/12ee4bcdefe9172b89171096ef33ad22ebb0d47b7a5ac958855fcc579a928a5a2a72078d686cf21c8a30ea9b7bae6062fa6f25385258d2df1a9245a48b857326
10560+
languageName: node
10561+
linkType: hard
10562+
1055610563
"require-directory@npm:^2.1.1":
1055710564
version: 2.1.1
1055810565
resolution: "require-directory@npm:2.1.1"

0 commit comments

Comments
 (0)