commit 0dcafe8557f3b5da338f4821ebee8cfa3920909e parent eb0b192106a5b8d09eff8a4c4956153137680c3b Author: Taixu Chen <chentaixu@gmail.com> Date: Tue, 25 Aug 2015 03:26:42 +0800 Update the README.md file Added explanations to the tools folder and removed the deprecated 'webpack.config.js' which is no longer there. The deploy.js is not implemented by default so I added an explanation. This change should make the react-starter-kit easier to understand as of the current version. Diffstat:
| M | README.md | | | 12 | ++++++++++-- |
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md @@ -49,9 +49,17 @@ Join [#react-starter-kit](https://gitter.im/kriasoft/react-starter-kit) chatroom │ ├── /app.js # Client-side startup script │ └── /server.js # Server-side startup script ├── /tools/ # Build automation scripts and utilities +│ ├── /lib/ # Library for utility snippets +│ ├── /build.js # Builds the project from source to output (build) folder +│ ├── /bundle.js # Bundles the web resources into package(s) through webpack +│ ├── /clean.js # Cleans up the output (build) folder +│ ├── /config.js # Webpack configuration for both client and server side bundles +│ ├── /copy.js # Copies static files to output (build) folder +│ ├── /serve.js # Launches the Node.js/Express web server in a seperate process +│ ├── /start.js # Launches the development web server with "live reload" functionality +│ └── /(deploy.js) # Deploys your webapp (Planned) │── package.json # The list of 3rd party libraries and utilities -│── preprocessor.js # ES6 transpiler settings for Jest -└── webpack.config.js # Webpack configuration for bundling and optimization +└── preprocessor.js # ES6 transpiler settings for Jest ``` ### Getting Started