Skip to content

Commit 6923eea

Browse files
committed
Update user guide.
1 parent f8816a0 commit 6923eea

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

react-native-scripts/template/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ Below you'll find information about performing common tasks. The most recent ver
1212
* [npm run android](#npm-run-android)
1313
* [npm run eject](#npm-run-eject)
1414
* [Writing and Running Tests](#writing-and-running-tests)
15+
* [Customizing App Display Name and Icon](#customizing-app-display-name-and-icon)
1516
* [Sharing and Deployment](#sharing-and-deployment)
1617
* [Publishing to Expo's React Native Community](#publishing-to-expos-react-native-community)
1718
* [Building an Expo "standalone" app](#building-an-expo-standalone-app)
1819
* [Ejecting from Create React Native App](#ejecting-from-create-react-native-app)
1920
* [Build Dependencies (Xcode & Android Studio)](#build-dependencies-xcode-android-studio)
2021
* [Should I Use ExpoKit?](#should-i-use-expokit)
22+
* [Tips and Tricks](#tips-and-tricks)
2123

2224
## Updating to New Releases
2325

@@ -55,9 +57,17 @@ This will start the process of "ejecting" from Create React Native App's build s
5557

5658
**Warning:** Running eject is a permanent action (aside from whatever version control system you use). An ejected app will require you to have an [Xcode and/or Android Studio environment](https://facebook.github.io/react-native/docs/getting-started.html) set up.
5759

60+
## Customizing App Display Name and Icon
61+
62+
You can edit `app.json` to include [configuration keys](https://docs.expo.io/versions/latest/guides/configuration.html) under the `expo` key.
63+
64+
To change your app's display name, set the `expo.name` key in `app.json` to an appropriate string.
65+
66+
To set an app icon, set the `expo.icon` key in `app.json` to be either a local path or a URL. It's recommended that you use a 512x512 png file with transparency.
67+
5868
## Writing and Running Tests
5969

60-
This project is set up to use [jest](https://facebook.github.io/jest/) for tests. You can configure whatever testing strategy you like, but jest works out of the box. Create test files in directories called `__tests__` to have the files loaded by jest. See the [the template project](https://github.com/react-community/create-react-native-app/tree/master/react-native-scripts/template/__tests__) for an example test. The [jest documentation](https://facebook.github.io/jest/docs/getting-started.html) is also a wonderful resource.
70+
This project is set up to use [jest](https://facebook.github.io/jest/) for tests. You can configure whatever testing strategy you like, but jest works out of the box. Create test files in directories called `__tests__` to have the files loaded by jest. See the [the template project](https://github.com/react-community/create-react-native-app/tree/master/react-native-scripts/template/__tests__) for an example test. The [jest documentation](https://facebook.github.io/jest/docs/getting-started.html) is also a wonderful resource, as is the [React Native testing tutorial](https://facebook.github.io/jest/docs/tutorial-react-native.html).
6171

6272
## Sharing and Deployment
6373

@@ -87,3 +97,7 @@ This is usually as simple as running `npm run eject` in your project, which will
8797
#### Should I Use ExpoKit?
8898

8999
If you have made use of Expo APIs while working on your project, then those API calls will stop working if you eject to a regular React Native project. If you want to continue using those APIs, you can eject to "React Native + ExpoKit" which will still allow you to build your own native code and continue using the Expo APIs. See the [ejecting guide](https://github.com/react-community/create-react-native-app/blob/master/EJECTING.md) for more details about this option.
100+
101+
## Tips and Tricks
102+
103+
* If you have a local network the prevents your phone from accessing the address that is printed when running the packager, you can often work around this issue by "tethering" your computer to your phone's internet connection. Some phones call this feature "mobile hotspot." While it's very convenient, if you have a data plan where you pay for data transfer you should be careful when using this feature, especially when installing dependencies from NPM.

0 commit comments

Comments
 (0)