diff --git a/README.md b/README.md index 100d414d48ce2ccfd1d16da003191289b14ee987..888a5bb4ab6b4fd76088803893d88b881171f98e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ # basic-react-redux-webpack4-boilerplate Basic React-Webpack4 boilerplate with classic file structure for React/Redux application . + +### Usage + +``` +git clone https://github.com/Lavitr/basic-react-redux-webpack4-boilerplate.git +cd basic-react-redux-webpack4-boilerplate +npm install +npm start +open http://localhost:8080 (should start automatically ) + +Now edit `src/components/App.js`. + +## Available Commands + +- `npm start` - start the dev server +- `npm clean` - delete the dist folder +- `npm run dev` - create a developer build in `dist` folder +- `npm run build` - create a production ready build in `dist` folder +- `npm test` - run all tests + +``` +### Dependencies + +* React +* Webpack +* [webpack-dev-server](https://github.com/webpack/webpack-dev-server) +* [babel-loader](https://github.com/babel/babel-loader)