Skip to content

Commit d901d48

Browse files
committed
docs: improve CLI docs
1 parent d7393de commit d901d48

2 files changed

Lines changed: 6 additions & 7 deletions

File tree

docs/docs/docs/cli/brownie.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Usage with Brownie package
22

3-
The `brownfield codegen` CLI command generates Brownie state management library native store types from TypeScript schema.
3+
The `brownfield codegen` CLI command generates `@callstack/brownie` (Brownie) state management library native store types from TypeScript schema.
44

55
## Usage
66

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
# Unified brownfield CLI
22

3-
The React Native Brownfield ecosystem comes with a batteries-included, all-in-one CLI tool called `brownfield` that helps you build and publish your React Native app as a framework artifact for iOS (XCFramework) and Android (AAR).
4-
Additionally, it contains CLI utilities for other tools like the `@callstack/brownie` state management tool.
3+
The React Native Brownfield ecosystem comes with a batteries-included, all-in-one CLI tool exposing the binary `brownfield`.
4+
The CLI automates the process of packaging a React Native / Expo app as a framework artifact for iOS (XCFramework) and Android (AAR).
5+
The `brownfield` CLI is the home for the whole brownfield ecosystem, hosting both the tools for `@callstack/react-native-brownfield` and for `@callstack/brownie` state management library.
56

6-
> [!NOTE]
7-
> The `brownfield` CLI is a unified tool serving both the needs of `@callstack/react-native-brownfield` and `@callstack/brownie` packages. The name `brownfield` does not mean it is only meant for `@callstack/brownie` state management tool; it is the main CLI for React Native Brownfield as well.
8-
> Technically, the CLI itself is encapsulated in the `@callstack/brownie-cli` package, which is a dependency of both `@callstack/react-native-brownfield` and `@callstack/brownie`. Therefore, installing either of the packages will bring the `brownfield` CLI tool to your project.
7+
Technically, the CLI itself is encapsulated in the `@callstack/brownfield-cli` package, which is a dependency of both `@callstack/react-native-brownfield` and `@callstack/brownie`. Therefore, installing either of the packages will bring the `brownfield` CLI tool to your project.
98

109
## Usage
1110

12-
Please refer to the appropriate pages for detailed usage instructions:
11+
Please refer to the appropriate pages for detailed usage instructions for each of the ecosystem packages:
1312

1413
- [`@callstack/react-native-brownfield` - Brownfield library commands](./brownfield)
1514
- [`@callstack/brownie` - Brownie state management library commands](./brownie)

0 commit comments

Comments
 (0)