refactored some of the descriptions to be more specific

2018-03-06 18:26:28 +01:00
1 changed files with 7 additions and 10 deletions
@@ -2,9 +2,7 @@

 Clean and minimalist React Native template for a quick start with TypeScript.

-This template can be used with the React Native CLI, which means it doesn't mess with the platform specific files.
-Instead of including a lot of dependencies, my aim when creating this template was to provide a very easy and minimalist
-way to start your React Native project with TypeScript. Of course you can always include other dependencies as you need them.
+This template can be used with the React Native CLI, which means it doesn't mess with the platform specific files. Instead of including a lot of dependencies, my aim when creating this template was to provide a very easy and minimalist way to start your React Native project with TypeScript. Of course you can always include other dependencies as you need them.

 ## :arrow_forward: Quick Start

@@ -16,10 +14,6 @@ node setup.js

 ## :question: FAQ

-### Why the post install script?
-
-The React Native CLI supports automatic installation of production dependencies only. Since TypeScript type definitions are dev dependencies, the post install script is being used mainly to install those.
-
 ### What is included in this template?

 - [TypeScript](https://github.com/Microsoft/TypeScript)
@@ -27,7 +21,11 @@ The React Native CLI supports automatic installation of production dependencies
 - [TSLint](https://github.com/palantir/tslint)
 - [TSLint React](https://github.com/palantir/tslint-react)

-This template always uses the latest versions of the dependencies at the time when the `react-native init` command is being executed. This means you don't have to worry about old versions.
+This template always uses the latest versions of the dependencies at the time when the setup script (`node setup.js`) is being executed. This means you don't have to worry about old versions.
+
+### Why the setup script?
+
+The React Native CLI supports automatic installation of production dependencies only. Since TypeScript and the other dependencies are dev dependencies, the setup script is being used to install those. It also takes care of obsolete files like the `.flowconfig` and the `setup.js` itself after the setup.

 ### What about Jest?

@@ -35,8 +33,7 @@ This template does not cover Jest yet. For more info on the current status check

 ### How will this template affect the React Native CLI workflow?

-The React Native CLI will do everything just as without a template and afterwards overwrite the files with the ones from
-this template. This means you don't have to worry about incompatibility issues with later React Native upgrades.
+The React Native CLI will do everything just as without a template and afterwards overwrite the files with the ones from this template. This means you don't have to worry about incompatibility issues with later React Native upgrades.

 ## :hearts: Contributing