nx-react-native-cli 2.4.0 → 2.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -7,10 +7,65 @@
7
7
 
8
8
  A comprehensive React Native mobile application starter kit built with Nx workspace. This package provides a carefully curated set of tools and libraries to streamline your mobile app development process with React Native 0.83.1 and the New Architecture.
9
9
 
10
- <h2 id="🛠-usage">🛠 Usage</h2>
11
- <p>Generate a new Nx workspace with the React Native preset:</p>
12
- <pre><code class="language-bash">npx nx-react-native-cli@latest create
13
- </code></pre>
10
+ ## 🛠 Usage
11
+
12
+ ### Create Command
13
+
14
+ Create a new Nx workspace with React Native:
15
+
16
+ **Interactive mode** (omit parameters to get prompts):
17
+ ```bash
18
+ npx nx-react-native-cli@latest create
19
+ ```
20
+
21
+ OR
22
+
23
+ ```bash
24
+ npx nx-react-native-cli@latest create [workspace_name] [bundle_id]
25
+ ```
26
+
27
+ **Options:**
28
+ - `--fresh` - Create without copying template files
29
+ - `--nx-version <version>` - Specify Nx version (default: 21.2.2)
30
+ - `--skip-install` - Skip yarn install
31
+ - `--skip-configs` - Skip prettier, eslint, and husky configs
32
+
33
+ **Examples:**
34
+ ```bash
35
+ npx nx-react-native-cli@latest create MyApp com.company.myapp
36
+ npx nx-react-native-cli@latest create MyApp com.company.myapp --skip-configs
37
+ ```
38
+
39
+ ### Add Command
40
+
41
+ Add React Native to an existing Nx workspace:
42
+
43
+ **Interactive mode** (omit parameters to get prompts):
44
+ ```bash
45
+ cd my-existing-workspace
46
+ npx nx-react-native-cli@latest add
47
+ ```
48
+
49
+ OR
50
+
51
+ ```bash
52
+ npx nx-react-native-cli@latest add [app_name] [bundle_id]
53
+ ```
54
+
55
+
56
+ **Options:**
57
+ - `--fresh` - Add without copying template files
58
+ - `--skip-install` - Skip yarn install
59
+ - `--skip-configs` - Skip prettier, eslint, and husky configs
60
+
61
+ **Note:** Automatically detects NX version from workspace package.json
62
+
63
+ **Examples:**
64
+ ```bash
65
+ cd my-existing-workspace
66
+ npx nx-react-native-cli@latest add MyApp com.company.myapp
67
+ npx nx-react-native-cli@latest add MyApp com.company.myapp --skip-configs
68
+ ```
14
69
 
15
70
  ## 🚀 Features
16
71