Skip to content

Commit 7d1257b

Browse files
Jack Reidanp
Jack Reid
authored andcommitted
Documentation Improvements (#70)
* Expand idiosyncratic version references to Node and NPM * Expand CRNA to Create React Native App Although the full name is wordy, I think it pays to avoid an initialism here. Create React App's docs always use the full name, and that's only one word fewer. * Remove yarn references from tl;dr code example We can explain the options for running through NPM or Yarn elsewhere. It is best to avoid any decision overload during the "oh, how does this thing work phase". Besides if you have Yarn, then you have NPM and these commands will work. * Direct links to Getting Started and User Guide Taking another leaf out of Create React App's book here and adding the link to these two resources right at the top for hot path users who know what they're after and just want the link. The User Guide section is redundant if we just link right through. * If everything is emphasises, nothing is emphasised * Specify NPM v3 * Standardise capitalisation * Move Support and Contact up the order * Turn Limitations into an FAQ section * Reorder FAQs * Reformat FAQ headers and responses * Remove extra line in code block
1 parent 6da19bb commit 7d1257b

File tree

2 files changed

+26
-22
lines changed

2 files changed

+26
-22
lines changed

README.md

+25-21
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,17 @@
22

33
Create React Native apps with no build configuration.
44

5-
## tl;dr
5+
* [Getting Started](#getting-started)
6+
* [User Guide](https://github.com/react-community/create-react-native-app/blob/master/react-native-scripts/template/README.md)
7+
8+
Once you're up and running with Create React Native App, visit [this tutorial](https://facebook.github.io/react-native/docs/tutorial.html) for more information on building apps with React Native.
9+
10+
## Quick Overview
611

712
Make sure you have Node 6 or later installed. No Xcode or Android Studio installation is required.
813

914
```sh
10-
# substitute for appropriate yarn commands if it's installed
1115
$ npm install -g create-react-native-app
12-
1316
$ create-react-native-app my-app
1417
$ cd my-app/
1518
$ npm start
@@ -22,10 +25,9 @@ Create React Native App allows you to work with all of the [Components and APIs]
2225
## Sections
2326

2427
* [Getting Started](#getting-started)
25-
* [User Guide](#user-guide)
2628
* [Philosophy](#philosophy)
27-
* [Limitations and Capabilities](#limitations-and-capabilities)
2829
* [Support and Contact](#support-and-contact)
30+
* [FAQs](#faqs)
2931
* [Contributing](#contributing)
3032

3133
## Getting Started
@@ -40,7 +42,7 @@ $ npm install -g create-react-native-app
4042
$ yarn global add create-react-native-app
4143
```
4244

43-
**You'll need to have Node >= 6 on your machine. We strongly recommend using npm >= 3 or a recent version of yarn.**
45+
You'll need to have Node v6 or later on your machine. We strongly recommend using NPM v3 or later, or a recent version of Yarn.
4446

4547
### Creating an App
4648

@@ -79,39 +81,41 @@ This will start the process of "ejecting" from Create React Native App's build s
7981

8082
**Warning:** Running eject is a **permanent** action. Please use a version control system, such as git, so you can revert back if necessary. 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.
8183

82-
## User Guide
83-
84-
Please refer to the [User Guide](https://github.com/react-community/create-react-native-app/blob/master/react-native-scripts/template/README.md) for more details about CRNA specifically.
85-
86-
Once you're up and running with CRNA, visit [this tutorial](https://facebook.github.io/react-native/docs/tutorial.html) for more information on building apps with React Native.
87-
8884
## Philosophy
8985

9086
* **Minimal "Time to Hello World"**: Create React Native App should reduce the setup time it takes to try building a mobile app to the absolute minimum, ideally on par with React web development (especially as seen with [Create React App](https://github.com/facebookincubator/create-react-app)).
9187
* **Develop on Your Device**: It should be easy to develop on a physical device when you want to test how your app feels and responds to inputs.
9288
* **One Build Tool**: If you just want to get started with React Native, you shouldn't need to install Xcode, Android Studio, NDKs, or mess with environment variables.
9389
* **No Lock-In**: You can always "eject" to your own build setup if you need to write custom native code or modify how your app is built.
9490

95-
## Limitations and Capabilities
91+
## Support and Contact
92+
93+
If you're having issues with Create React Native App, please make sure:
9694

97-
The main limitation of a CRNA project is that it must be written in pure JavaScript and not have any dependencies which rely on custom native code (i.e. ones which require running `react-native link` to work). This allows the projects to load directly on a phone without native compilation, and also means that it's not necessary to install or use Android Studio or Xcode.
95+
* The issue is not covered in the [Getting Started](https://github.com/react-community/create-react-native-app#getting-started) or [User Guide](https://github.com/react-community/create-react-native-app/blob/master/react-native-scripts/template/README.md) documentation
96+
* There is not already an [open issue](https://github.com/react-community/create-react-native-app/issues) for your particular problem
97+
98+
If you've checked the documentation and currently open issues, please either open a new GitHub issue, [find @dika10sune on Twitter](https://twitter.com/dika10sune), or ping `dikaiosune` on [Reactiflux](https://www.reactiflux.com/)'s #react-native channel on Discord. **Please do not DM or email project maintainers directly**, as it's very important that support takes place in public locations where others can benefit from the conversation.
99+
100+
## FAQs
101+
102+
### What API specification should I be looking at while developing?
98103

99104
Apps made with Create React Native App support everything in the Components and APIs sections of the [React Native Documentation](https://facebook.github.io/react-native/docs/getting-started.html).
100105

101106
Apps made with Create React Native App also support most of the JavaScript-to-Native APIs provided by the [Expo SDK](https://docs.expo.io/versions/latest/sdk/index.html), since they are loaded by the Expo app.
102107

103-
If you're sure that you need custom native code, please read the [ejecting guide](https://github.com/react-community/create-react-native-app/blob/master/EJECTING.md).
108+
### What are the limitations of Create React Native App?
104109

105-
If you need to build IPAs and APKs for publishing to the App Store and/or Play Store, you can either eject (see above guide) and build them yourself using Xcode and Android Studio, or you can use a service like [Expo's standalone app builds](https://docs.expo.io/versions/v13.0.0/guides/building-standalone-apps.html) to publish your pure JS app.
110+
The main limitation of a Create React Native App project is that it must be written in pure JavaScript and not have any dependencies which rely on custom native code (i.e. ones which require running `react-native link` to work). This allows the projects to load directly on a phone without native compilation, and also means that it's not necessary to install or use Android Studio or Xcode.
106111

107-
## Support and Contact
112+
### What if I want to write custom native code for my app?
108113

109-
If you're having issues with Create React Native App, please make sure:
114+
If you're sure that you need custom native code, please read the [ejecting guide](https://github.com/react-community/create-react-native-app/blob/master/EJECTING.md).
110115

111-
* The issue is not covered in the [Getting Started](https://github.com/react-community/create-react-native-app#getting-started) or [User Guide](https://github.com/react-community/create-react-native-app/blob/master/react-native-scripts/template/README.md) documentation
112-
* There is not already an [open issue](https://github.com/react-community/create-react-native-app/issues) for your particular problem
116+
### How do I get my app into the Play Store/App Store?
113117

114-
If you've checked the documentation and currently open issues, please either open a new GitHub issue, [find @dika10sune on Twitter](https://twitter.com/dika10sune), or ping `dikaiosune` on [Reactiflux](https://www.reactiflux.com/)'s #react-native channel on Discord. **Please do not DM or email project maintainers directly**, as it's very important that support takes place in public locations where others can benefit from the conversation.
118+
If you need to build IPAs and APKs for publishing to the App Store and/or Play Store, you can either eject (see above guide) and build them yourself using Xcode and Android Studio, or you can use a service like [Expo's standalone app builds](https://docs.expo.io/versions/v13.0.0/guides/building-standalone-apps.html) to publish your pure JS app.
115119

116120
## Contributing
117121

react-native-scripts/template/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Upgrading to a new version of React Native requires updating the `react-native`,
3131

3232
## Available Scripts
3333

34-
If yarn was installed when the project was initialized, then dependencies will have been installed via yarn, and you should probably use it to run these commands as well. Unlike dependency installation, command running syntax is identical for yarn and npm at the time of this writing.
34+
If Yarn was installed when the project was initialized, then dependencies will have been installed via Yarn, and you should probably use it to run these commands as well. Unlike dependency installation, command running syntax is identical for Yarn and NPM at the time of this writing.
3535

3636
### `npm start`
3737

0 commit comments

Comments
 (0)