From 92afcaf854be9c05e7c0c52892172031d7bb6bfe Mon Sep 17 00:00:00 2001 From: Dan Abramov <dan.abramov@gmail.com> Date: Fri, 23 Sep 2016 13:00:11 +0100 Subject: [PATCH] Add READMEs for packages --- packages/babel-preset-react-app/README.md | 6 +++++- packages/create-react-app/README.md | 7 +++++++ packages/eslint-config-react-app/README.md | 6 +++++- packages/react-scripts/README.md | 7 +++++++ 4 files changed, 24 insertions(+), 2 deletions(-) create mode 100644 packages/create-react-app/README.md create mode 100644 packages/react-scripts/README.md diff --git a/packages/babel-preset-react-app/README.md b/packages/babel-preset-react-app/README.md index 801d189e1..b28936832 100644 --- a/packages/babel-preset-react-app/README.md +++ b/packages/babel-preset-react-app/README.md @@ -1,6 +1,10 @@ # babel-preset-react-app -This package includes the Babel preset used by [Create React App](https://github.com/facebookincubator/create-react-app). +This package includes the Babel preset used by [Create React App](https://github.com/facebookincubator/create-react-app). +Please refer to its documentation: + +* [Getting Started](https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app. +* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App. ## Usage in Create React App Projects diff --git a/packages/create-react-app/README.md b/packages/create-react-app/README.md new file mode 100644 index 000000000..062a32025 --- /dev/null +++ b/packages/create-react-app/README.md @@ -0,0 +1,7 @@ +# create-react-app + +This package includes the global command for [Create React App](https://github.com/facebookincubator/create-react-app). +Please refer to its documentation: + +* [Getting Started](https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app. +* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App. diff --git a/packages/eslint-config-react-app/README.md b/packages/eslint-config-react-app/README.md index 7197134a9..0967e94b9 100644 --- a/packages/eslint-config-react-app/README.md +++ b/packages/eslint-config-react-app/README.md @@ -1,6 +1,10 @@ # eslint-config-react-app -This package includes the shareable ESLint configuration used by [Create React App](https://github.com/facebookincubator/create-react-app). +This package includes the shareable ESLint configuration used by [Create React App](https://github.com/facebookincubator/create-react-app). +Please refer to its documentation: + +* [Getting Started](https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app. +* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App. ## Usage in Create React App Projects diff --git a/packages/react-scripts/README.md b/packages/react-scripts/README.md new file mode 100644 index 000000000..845e546c6 --- /dev/null +++ b/packages/react-scripts/README.md @@ -0,0 +1,7 @@ +# react-scripts + +This package includes scripts and configuration used by [Create React App](https://github.com/facebookincubator/create-react-app). +Please refer to its documentation: + +* [Getting Started](https://github.com/facebookincubator/create-react-app/blob/master/README.md#getting-started) – How to create a new app. +* [User Guide](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App. -- GitLab