Skip to content

Commit 992be81

Browse files
authored
Merge pull request #45 from EvanBacon/@evanbacon/updated-readme
docs: updated docs to reflect Expo SDK 41
2 parents 7322b21 + 4f6ffb6 commit 992be81

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,38 +16,45 @@ Make sure [npx](https://github.com/npm/npx) is installed and run the following c
1616

1717
`npx react-native-bundle-visualizer`
1818

19-
And when using Expo:
19+
And when using Expo SDK 40 or lower. Learn more: [Expo extensions](http://expo.fyi/expo-extension-migration).
2020

2121
`npx react-native-bundle-visualizer --expo managed`
2222

2323
### Or install as a dev-dependency
2424

25-
`yarn add --dev react-native-bundle-visualizer`
25+
```sh
26+
yarn add --dev react-native-bundle-visualizer
27+
```
2628

2729
And run it:
2830

29-
yarn run react-native-bundle-visualizer
31+
```
32+
yarn run react-native-bundle-visualizer
33+
```
3034

3135
_or when using npm:_
3236

33-
npm install --save-dev react-native-bundle-visualizer
34-
./node_modules/.bin/react-native-bundle-visualizer
37+
```
38+
npm install --save-dev react-native-bundle-visualizer ./node_modules/.bin/react-native-bundle-visualizer
39+
```
3540

3641
## Command line arguments
3742

3843
All command-line arguments are optional. By default a production build will be created for the `ios` platform.
3944

40-
| Option | Description | Example |
41-
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |
42-
| `platform` | Platform to build (default is **ios**) | `--platform android` |
43-
| `expo` | Expo target, **managed** or **bare**. This ensures that the project is bundled with expo settings and that `.expo` file extensions are handled appropriately. | `--expo bare` |
44-
| `dev` | Dev or production build (default is **false**) | `--dev false` |
45-
| `entry-file` | Entry-file (when omitted tries to auto-resolve it) | `--entry-file ./index.android.js` |
46-
| `bundle-output` | Output bundle-file (default is **tmp**) | `--bundle-output ./myapp.bundle` |
47-
| `format` | Output format **html**, **json** or **tsv** (default is **html**) (see [source-map-explorer options](https://github.com/danvk/source-map-explorer#options)) | `--format json` |
48-
| `only-mapped` | Exclude "unmapped" bytes from the output (default is **false**). This will result in total counts less than the file size. | `--only-mapped` |
49-
| `verbose` | Dumps additional output to the console (default is **false**) | `--verbose` |
50-
| `reset-cache` | Removes cached react-native files (default is **false**) | `--reset-cache` |
45+
| Option | Description | Example |
46+
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------- |
47+
| `platform` | Platform to build (default is **ios**) | `--platform ios` |
48+
| `expo` | (Deprecated in SDK 41+) Expo target, **managed** or **bare**. Ensures that the project is bundled with expo settings and that `.expo.*` extensions are used. | `--expo bare` |
49+
| `dev` | Dev or production build (default is **false**) | `--dev false` |
50+
| `entry-file` | Entry-file (when omitted tries to auto-resolve it) | `--entry-file ./index.ios.js` |
51+
| `bundle-output` | Output bundle-file (default is **tmp**) | `--bundle-output ./myapp.bundle` |
52+
| `format` | Output format **html**, **json** or **tsv** (default is **html**) (see [source-map-explorer options][smeo]) | `--format json` |
53+
| `only-mapped` | Exclude "unmapped" bytes from the output (default is **false**). This will result in total counts less than the file size. | `--only-mapped` |
54+
| `verbose` | Dumps additional output to the console (default is **false**) | `--verbose` |
55+
| `reset-cache` | Removes cached react-native files (default is **false**) | `--reset-cache` |
56+
57+
[smeo]: https://github.com/danvk/source-map-explorer#options
5158

5259
## Usage with older react-native versions and the Haul bundler
5360

0 commit comments

Comments
 (0)