update doc

Author: NewFuture

README.md

@@ -1,17 +1,19 @@
-# [Create DG-React](https://github.com/MS-DG/create-dg-react) [![Build Status](https://dev.azure.com/facebook/create-react-app/_apis/build/status/facebook.create-react-app?branchName=master)](https://dev.azure.com/facebook/create-react-app/_build/latest?definitionId=1&branchName=master) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://github.com/facebook/create-react-app/blob/master/CONTRIBUTING.md)
+# [Create DG-React](https://github.com/MS-DG/create-dg-react)
 
-Create React apps with no build configuration.
+Create DG React apps with no build configuration.
+
+> **You should login to the Microsoft Corp with your MSFT acount in your PC. When use the Default Template**
 
 - [Creating an App](#creating-an-app) – How to create a new app.
 - [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.
 
-Create React App works on macOS, Windows, and Linux.
+Create DG React App works on macOS, Windows, and Linux.
 
 ## Quick Overview
 
 ```sh
-npm create dg-react my-app
-cd my-app
+npm create dg-react dg-app
+cd dg-app
 npm start
 ```
 
@@ -36,32 +38,34 @@ To create a new app, you may choose one of the following methods:
 ### npx
 
 ```sh
-npx create-react-app my-app
+npx create-dg-react dg-app
 ```
 
 _([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) is a package runner tool that comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
 
 ### npm
 
 ```sh
-npm init dg-react my-app
+npm create dg-react dg-app
 ```
 
-_`npm init <initializer>` is available in npm 6+_
+_`npm create <initializer>` is available in npm 6+_
 
 ### Yarn
 
 ```sh
-yarn create dg-react my-app
+yarn create dg-react dg-app
 ```
 
 _`yarn create` is available in Yarn 0.25+_
 
-It will create a directory called `my-app` inside the current folder.<br>
+### Default template
+
+It will create a directory called `dg-app` inside the current folder.<br>
 Inside that directory, it will generate the initial project structure and install the transitive dependencies:
 
 ```
-my-app
+dg-app
 ├── README.md
 ├── node_modules
 ├── package.json
@@ -74,7 +78,7 @@ my-app
     ├── App.scss
     ├── App.tsx
     ├── App.test.tsx
-    ├── index.css
+    ├── index.scss
     ├── index.tsx
     ├── logo.svg
     └── serviceWorker.ts
@@ -84,31 +88,33 @@ No configuration or complicated folder structures, only the files you need to bu
 Once the installation is done, you can open your project folder:
 
 ```sh
-cd my-app
+cd dg-app
 ```
 
 Inside the newly created project, you can run some built-in commands:
 
-### `npm start` or `yarn start`
+#### `npm start` or `yarn start`
+
+Runs the app in development mode.
 
-Runs the app in development mode.<br>
 Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
 
-The page will automatically reload if you make changes to the code.<br>
+The page will automatically reload if you make changes to the code.
+
 You will see the build errors and lint warnings in the console.
 
 <p align='center'>
 <img src='https://cdn.jsdelivr.net/gh/marionebl/create-react-app@9f6282671c54f0874afd37a72f6689727b562498/screencast-error.svg' width='600' alt='Build errors'>
 </p>
 
-### `npm test` or `yarn test`
+#### `npm test` or `yarn test`
 
-Runs the test watcher in an interactive mode.<br>
+Runs the test watcher in an interactive mode.
 By default, runs tests related to files changed since the last commit.
 
 [Read more about testing.](https://facebook.github.io/create-react-app/docs/running-tests)
 
-### `npm run build` or `yarn build`
+#### `npm run build` or `yarn build`
 
 Builds the app for production to the `build` folder.<br>
 It correctly bundles React in production mode and optimizes the build for the best performance.
@@ -119,24 +125,31 @@ Your app is ready to be deployed.
 
 ## User Guide
 
-You can find detailed instructions on using Create React App and many tips in [its documentation](https://facebook.github.io/create-react-app/).
+You can find detailed instructions on using Create DG App and many tips in [Create React App documentation (almost the same behaviors)](https://facebook.github.io/create-react-app/).
+
+### How to Update to New Versions?
+
+#### if you want to update current project (already exists)
 
-## How to Update to New Versions?
+just update the dependency `@dragongate/react-scripts`.
 
-Please refer to the [User Guide](https://facebook.github.io/create-react-app/docs/updating-to-new-releases) for this and other information.
+#### if you want to create a new project
+
+just [create a app](#creating-an-app) without global install.
 
 ## Philosophy
 
 - **One Dependency:** There is only one build dependency. It uses Webpack, Babel, ESLint, and other amazing projects, but provides a cohesive curated experience on top of them.
 
-- **No Configuration Required:** You don't need to configure anything. A reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.
-
-- **No Lock-In:** You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.
+- **No Configuration:** You don't need to configure anything. A reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.
 
 ## What’s Included?
 
 Your environment will have everything you need to build a modern single-page React app:
 
+- Integrated with Azure pipelines
+- Shared vscode (IDE) config and plugins
+- Force formatting
 - React, JSX, ES6, TypeScript and Flow syntax support.
 - Language extras beyond ES6 like the object spread operator.
 - Autoprefixed CSS, so you don’t need `-webkit-` or other prefixes.
@@ -146,44 +159,8 @@ Your environment will have everything you need to build a modern single-page Rea
 - An offline-first [service worker](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers) and a [web app manifest](https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/), meeting all the [Progressive Web App](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) criteria. (_Note: Using the service worker is opt-in as of `react-scripts@2.0.0` and higher_)
 - Hassle-free updates for the above tools with a single dependency.
 
-Check out [this guide](https://github.com/nitishdayal/cra_closer_look) for an overview of how these tools fit together.
-
 The tradeoff is that **these tools are preconfigured to work in a specific way**. If your project needs more customization, you can ["eject"](https://facebook.github.io/create-react-app/docs/available-scripts#npm-run-eject) and customize it, but then you will need to maintain this configuration.
 
-## Popular Alternatives
-
-Create React App is a great fit for:
-
-- **Learning React** in a comfortable and feature-rich development environment.
-- **Starting new single-page React applications.**
-- **Creating examples** with React for your libraries and components.
-
-Here are a few common cases where you might want to try something else:
-
-- If you want to **try React** without hundreds of transitive build tool dependencies, consider [using a single HTML file or an online sandbox instead](https://reactjs.org/docs/try-react.html).
-
-- If you need to **integrate React code with a server-side template framework** like Rails, Django or Symfony, or if you’re **not building a single-page app**, consider using [nwb](https://github.com/insin/nwb), or [Neutrino](https://neutrino.js.org/) which are more flexible. For Rails specifically, you can use [Rails Webpacker](https://github.com/rails/webpacker). For Symfony, try [Symfony's Webpack Encore](https://symfony.com/doc/current/frontend/encore/reactjs.html).
-
-- If you need to **publish a React component**, [nwb](https://github.com/insin/nwb) can [also do this](https://github.com/insin/nwb#react-components-and-libraries), as well as [Neutrino's react-components preset](https://neutrino.js.org/packages/react-components/).
-
-- If you want to do **server rendering** with React and Node.js, check out [Next.js](https://github.com/zeit/next.js/) or [Razzle](https://github.com/jaredpalmer/razzle). Create React App is agnostic of the backend, and only produces static HTML/JS/CSS bundles.
-
-- If your website is **mostly static** (for example, a portfolio or a blog), consider using [Gatsby](https://www.gatsbyjs.org/) instead. Unlike Create React App, it pre-renders the website into HTML at the build time.
-
-- Finally, if you need **more customization**, check out [Neutrino](https://neutrino.js.org/) and its [React preset](https://neutrino.js.org/packages/react/).
-
-All of the above tools can work with little to no configuration.
-
-If you prefer configuring the build yourself, [follow this guide](https://reactjs.org/docs/add-react-to-an-existing-app.html).
-
-## Acknowledgements
-
-We are grateful to the authors of existing related projects for their ideas and collaboration:
-
-- [@eanplatter](https://github.com/eanplatter)
-- [@insin](https://github.com/insin)
-- [@mxstbr](https://github.com/mxstbr)
-
 ## License
 
-Create React App is open source software [licensed as MIT](https://github.com/facebook/create-react-app/blob/master/LICENSE).
+MIT