Skip to content

Commit 863c4d6

Browse files
szymonrybczakszymonrybczak
authored
docs: fill README files (#255)
1 parent 68cf0ee commit 863c4d6

File tree

11 files changed

+47
-178
lines changed

11 files changed

+47
-178
lines changed

‎README.md‎

Lines changed: 1 addition & 103 deletions
Original file line numberDiff line numberDiff line change
@@ -29,106 +29,4 @@ npx @rnef/create-app enterprise
2929

3030
## Adding to existing projects
3131

32-
1. Install deps:
33-
34-
```sh
35-
npm install -D @rnef/cli @rnef/plugin-metro @rnef/platform-android @rnef/platform-ios
36-
```
37-
38-
1. Remove `@react-native-community/cli` and related packages.
39-
40-
1. Add `.rnef/` folder with caches to `.gitignore`:
41-
42-
```
43-
.rnef/
44-
```
45-
46-
1. Add `rnef.config.mjs` file:
47-
48-
```mjs
49-
// @ts-check
50-
import { platformIOS } from '@rnef/platform-ios';
51-
import { platformAndroid } from '@rnef/platform-android';
52-
import { pluginMetro } from '@rnef/plugin-metro';
53-
54-
/** @type {import('@rnef/config').Config} */
55-
export default {
56-
bundler: pluginMetro(),
57-
platforms: {
58-
ios: platformIOS(),
59-
android: platformAndroid(),
60-
},
61-
remoteCacheProvider: 'github-actions',
62-
};
63-
```
64-
65-
1. Update Android files:
66-
67-
In `android/app/build.gradle` uncomment the `cliFile` and update with the new path:
68-
69-
```diff
70-
-// cliFile = file("../../node_modules/react-native/cli.js")
71-
+cliFile = file("../../node_modules/@rnef/cli/dist/src/bin.js")
72-
```
73-
74-
In `android/settings.gradle` change:
75-
76-
```diff
77-
-extensions.configure(com.facebook.react.ReactSettingsExtension){ ex -> ex.autolinkLibrariesFromCommand() }
78-
+extensions.configure(com.facebook.react.ReactSettingsExtension){ ex -> ex.autolinkLibrariesFromCommand(['npx', 'rnef', 'config', '-p', 'android']) }
79-
```
80-
81-
1. Update iOS files:
82-
83-
In `ios/Podfile` change:
84-
85-
```diff
86-
-config = use_native_modules!
87-
+config = use_native_modules!(['npx', 'rnef', 'config', '-p', 'ios'])
88-
```
89-
90-
In "Bundle React Native code and images" Build Phase in Xcode add:
91-
92-
```diff
93-
set -e
94-
+if [[ -f "$PODS_ROOT/../.xcode.env" ]]; then
95-
+source "$PODS_ROOT/../.xcode.env"
96-
+fi
97-
+if [[ -f "$PODS_ROOT/../.xcode.env.local" ]]; then
98-
+source "$PODS_ROOT/../.xcode.env.local"
99-
+fi
100-
+export CONFIG_CMD="dummy-workaround-value"
101-
+export CLI_PATH="$("$NODE_BINARY" --print "require('path').dirname(require.resolve('@rnef/cli/package.json')) + '/dist/src/bin.js'")"
102-
WITH_ENVIRONMENT="$REACT_NATIVE_PATH/scripts/xcode/with-environment.sh"
103-
```
104-
105-
1. Cleanup native files:
106-
107-
```sh
108-
git clean -fdx ios/ android/
109-
```
110-
111-
1. Run new commands:
112-
113-
```sh
114-
npx rnef run:android
115-
npx rnef run:ios
116-
```
117-
118-
Additionally rename flags:
119-
120-
- `--mode` to `--variant` for Android commands
121-
- `--mode` to `--configuration` for iOS commands
122-
- `--buildFolder` to `--build-folder` for iOS commands
123-
- `--destination` to `--destinations` for iOS commands
124-
- `--appId` to `--app-id` for Android commands
125-
- `--appIdSuffix` to `--app-id-suffix` for Android commands
126-
127-
And remove unsupported flags:
128-
129-
- `--interactive`/`-i` – the CLI will prompt you for input where necessary
130-
- `--list-devices` - when no devices are connected, you'll be prompt with a full device selection
131-
132-
1. Configure GitHub Actions for remote builds as per [CI Docs](https://rnef.vercel.app/docs/remote-cache/github-actions/configuration.html)
133-
134-
1. (Optional) Add React Native to existing native app with a [brownfield plugin](https://rnef.vercel.app/docs/brownfield.html).
32+
To migrate your existing project, please follow steps described [here](https://rnef.vercel.app/docs/getting-started/migrating-from-community-cli).

‎packages/cli/README.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
# cli
1+
# @rnef/cli
22

3-
This library was generated with [Nx](https://nx.dev).
3+
Command-line interface for React Native Enterprise Framework (RNEF). This package is part of the RNEF ecosystem.
44

5-
## Building
5+
## Quick Start
66

7-
Run `nx build cli` to build the library.
7+
Create a new RNEF project:
88

9-
## Running unit tests
9+
```sh
10+
npx @rnef/create-app enterprise
11+
```
1012

11-
Run `nx test cli` to execute the unit tests via [Jest](https://jestjs.io).
13+
## Documentation
14+
15+
For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.vercel.app)

‎packages/config/README.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
# config
1+
# @rnef/config
22

3-
This library was generated with [Nx](https://nx.dev).
3+
Configuration utilities for React Native Enterprise Framework (RNEF), including autolinking for packages with native code. This package is part of the RNEF ecosystem.
44

5-
## Building
5+
## Documentation
66

7-
Run `nx build config` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test config` to execute the unit tests via [Vitest](https://vitest.dev/).
7+
For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.vercel.app)

‎packages/platform-android/README.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
# platform-android
1+
# @rnef/platform-android
22

3-
This library was generated with [Nx](https://nx.dev).
3+
Android platform integration for React Native Enterprise Framework (RNEF). This package is part of the RNEF ecosystem and provides Android-specific build and development tools.
44

5-
## Building
5+
## Documentation
66

7-
Run `nx build platform-android` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test platform-android` to execute the unit tests via [Vitest](https://vitest.dev/).
7+
For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.vercel.app)

‎packages/platform-apple-helpers/README.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
# platform-ios
1+
# @rnef/platform-apple-helpers
22

3-
This library was generated with [Nx](https://nx.dev).
3+
Internal utilities for Apple platform integration in React Native Enterprise Framework (RNEF). This package is part of the RNEF ecosystem and provides shared functionality for iOS and other Apple platforms.
44

5-
## Building
5+
## Documentation
66

7-
Run `nx build platform-ios` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test platform-ios` to execute the unit tests via [Vitest](https://vitest.dev/).
7+
For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.vercel.app)

‎packages/platform-ios/README.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
# platform-ios
1+
# @rnef/platform-ios
22

3-
This library was generated with [Nx](https://nx.dev).
3+
iOS platform integration for React Native Enterprise Framework (RNEF). This package is part of the RNEF ecosystem and provides iOS-specific build and development tools.
44

5-
## Building
5+
## Documentation
66

7-
Run `nx build platform-ios` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test platform-ios` to execute the unit tests via [Vitest](https://vitest.dev/).
7+
For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.vercel.app)

‎packages/plugin-brownfield-android/README.md‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
# plugin-brownfield-android
1+
# @rnef/plugin-brownfield-android
22

3-
This library was generated with [Nx](https://nx.dev).
3+
Android brownfield integration plugin for React Native Enterprise Framework (RNEF). This package is part of the RNEF ecosystem and provides tools for integrating React Native into existing Android applications.
44

5-
## Building
5+
## Documentation
66

7-
Run `nx build plugin-brownfield-android` to build the library.
7+
For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.vercel.app)
88

9-
## Running unit tests
10-
11-
Run `nx test plugin-brownfield-ios` to execute the unit tests via [Vitest](https://vitest.dev/).

‎packages/plugin-brownfield-ios/README.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
# plugin-brownfield-ios
1+
# @rnef/plugin-brownfield-ios
22

3-
This library was generated with [Nx](https://nx.dev).
3+
iOS brownfield integration plugin for React Native Enterprise Framework (RNEF). This package is part of the RNEF ecosystem and provides tools for integrating React Native into existing iOS applications.
44

5-
## Building
5+
## Documentation
66

7-
Run `nx build plugin-brownfield-ios` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test plugin-brownfield-ios` to execute the unit tests via [Vitest](https://vitest.dev/).
7+
For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.vercel.app)

‎packages/plugin-metro/README.md‎

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
1-
# plugin-metro
1+
# @rnef/plugin-metro
22

3-
This library was generated with [Nx](https://nx.dev).
3+
Metro bundler integration plugin for React Native Enterprise Framework (RNEF). This package is part of the RNEF ecosystem and provides integration with Metro, the default JavaScript bundler for React Native.
44

5-
## Building
5+
## Documentation
66

7-
Run `nx build plugin-metro` to build the library.
7+
For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.vercel.app)
88

9-
## Running unit tests
10-
11-
Run `nx test plugin-metro` to execute the unit tests via [Vitest](https://vitest.dev/).

‎packages/plugin-repack/README.md‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
# plugin-repack
1+
# @rnef/plugin-repack
22

3-
This library was generated with [Nx](https://nx.dev).
3+
Re.Pack integration plugin for React Native Enterprise Framework (RNEF). This package is part of the RNEF ecosystem and provides integration with [Re.Pack](https://re-pack.dev), a toolkit for building React Native apps with webpack or Rspack.
44

5-
## Building
5+
## Documentation
66

7-
Run `nx build plugin-repack` to build the library.
8-
9-
## Running unit tests
10-
11-
Run `nx test plugin-repack` to execute the unit tests via [Vitest](https://vitest.dev/).
7+
For detailed documentation about RNEF and its tools, visit [RNEF Documentation](https://rnef.vercel.app)

0 commit comments

Comments
 (0)