Skip to content

Commit 54e2488

Browse files
committed
docs: update
1 parent e6b1778 commit 54e2488

1 file changed

Lines changed: 5 additions & 9 deletions

File tree

docs/docs/docs/api-reference/brownie/overview.mdx

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Brownie
22

3-
:::warning Alpha
4-
Brownie is in alpha stage. APIs may change.
5-
:::
6-
73
Brownie is a shared state management library for React Native brownfield apps. It enables seamless state synchronization between your React Native code and native code.
84

95
## Features
@@ -24,15 +20,15 @@ Brownie is a shared state management library for React Native brownfield apps. I
2420
## How It Works
2521

2622
```
27-
┌─────────────────┐ ┌──────────────────┐ ┌─────────────────┐
28-
│ TypeScript │──────▶│ Brownfield CLI │──────▶│ Swift types
29-
│ Store Schema │ │ (codegen) │ │ (generated) │
30-
└─────────────────┘ └──────────────────┘ └─────────────────┘
23+
┌─────────────────┐ ┌──────────────────┐ ┌──────────────────────
24+
│ TypeScript │──────▶│ Brownfield CLI │──────▶│ Swift/Kotlin types │
25+
│ Store Schema │ │ (codegen) │ │ (generated)
26+
└─────────────────┘ └──────────────────┘ └──────────────────────
3127
```
3228

3329
1. Define your store shape in a `*.brownie.ts` file using TypeScript
3430
2. Run `brownfield codegen` to generate native types
35-
3. Use `useStore` in React Native and `@UseStore` in Swift
31+
3. Use `useStore` in React Native, `@UseStore` in Swift and `Store` in Kotlin
3632
4. State changes sync automatically between both sides
3733

3834
## Next Steps

0 commit comments

Comments
 (0)