Finalise Docs for v2.0.0

- Updated README.
- Updated CHANGELOG to reflect the newest changes in README.

Author: iamWing

CHANGELOG.md

@@ -6,8 +6,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## 2.0.0 - 2018-02-03
-v2.0.0 is a major release that refactored the most part of the boilerplate.
+## 2.0.0 - 2018-02-04
+v2.0.0 is a major release that most part of the boilerplate has been rewritten.
 
 ### Added
 - ESLint for code checking on Javascript files.
@@ -21,17 +21,17 @@ v2.0.0 is a major release that refactored the most part of the boilerplate.
   file and pack into Webpack's bundled package for production.
 - Build commands `build:mac` & `build:win` to package & build the installer of 
   your Electron app for macOS & Windows using `electron-builder`.
-  - _`asar` archiving is disabled by default for Windows build as some code 
-    will not work properly if it's on (saying based on experience). Users can 
-    turn it back on by removing `asar: false` in `build` section of
-    `package.json`._
+- README section "Building the installer for your Electron app" & sub-section 
+  "Extra options".
 
 ### Changed
 - Refactored Webpack config file to have `mainConfig` & `rendererConfig` 
   cleaned up, and set mode by environment variable.
 - `.gitignore` to ignore folder `out/` which will be auto-generated during the 
   build process.
-- README to refactor the changes made in `v2.0.0`.
+- README section "How does it work?" is now renamed to "Getting started" & 
+  completed the documentation of this section.
+- README section "Folder structure" to reflect the changes in `v2.0.0`.
 
 ### Fixed
 - CSS files fail to inject into views issue by setting Webpack to use 

README.md

@@ -1,18 +1,17 @@
-# **Electron-React-TypeScript-Webpack-Boilerplate**
-
+# Electron-React-TypeScript-Webpack-Boilerplate
 Pre-configured Electron.js + React.js + TypeScript boilerplate with 
 Webpack v4 & linters config predefined.
 
-This boilerplate works on Mac, Windows, and Linux. 
-If something doesn't work, please [file and issue](https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/issues/new).
+This boilerplate currently works on macOS and Windows. If something doesn't 
+work, please [file and issue](https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/issues/new).
 
-## **How Does It Work?**
-```
+## Getting started
+```bash
 // execute
 git clone https://github.com/iamWing/electron-react-typescript-base-proj.git
 ```
 
-```
+```json
 // edit the following fields in package.json for your own project
 {
   "name": {your-project-name},
@@ -22,19 +21,71 @@ git clone https://github.com/iamWing/electron-react-typescript-base-proj.git
     "appId": {your-app-id},
     "productName": {your-product-name},
     "buildVersion": {whatever-you-like}
-  }
+  },
   "author": {who's-the-author?},
-  "license": {if-you-don't-want-to-use-MIT}
+  "license": {if-you-don't-want-to-use-MIT},
   "repository": {type-and-link-of-your-repo},
   "keywords": {keywords-of-your-project},
   "bugs": {issue-page-of-your-repo},
   "homepage": {homepage-of-your-repo}
 }
 ```
 
-Then execute `npm run dev` to start develop your app.
+Then install all the `node_modules` needed by executing the following command:
+```bash
+cd {folder-containing-the-cloned-boilerplate}
+npm run install
+```
+
+Finally execute the following command to start Webpack in development mode and 
+watch the changes on source files.
+```bash
+npm run dev
+```
+
+## Building the installer for your Electron app
+The boilerplate is currently configured to package & build the installer of 
+your app for macOS & Windows using `electron-builder`. 
+
+For macOS, execute:
+```bash
+npm run build:mac
+```
+
+For Windows, execute:
+```bash
+npm run build:win
+```
+_** `asar` archiving is disabled by default in Windows build as it can cause 
+errors while running the installed Electron app based on pervious experiences, 
+whereas the macOS build with `asar` enabled works just fine. You can turn it 
+back on by removing line 23 (`"asar": false`) in `package.json`. **_
+
+### Extra options
+The build scripts are pre-configured to build 64 bit installers since 64 bit 
+should be the standard for a modern applications. 32 bit builds are still 
+possible by changing the build scripts in `package.json` as below:
+```json
+// from
+"scripts": {
+    ...
+    "build:win": "electron-builder build --win --x64",
+    "build:mac": "electron-builder build --mac --x64"
+},
 
-## **Folder structure**
+// to
+"scripts": {
+    ...
+    "build:win": "electron-builder build --win --ia32",
+    "build:mac": "electron-builder build --mac --ia32"
+},
+```
+
+Builds for Linux, armv71, and arm64 can also be configured by modifying the 
+build scripts in `package.json`, but those aren't tested yet. For details, 
+please refer to [documents of `electron-builder`](https://www.electron.build/cli).
+
+## Folder structure
 ```
 electron-react-typescript-base-proj/
 | - dist/               //- Generated by Webpack automatically
@@ -44,13 +95,14 @@ electron-react-typescript-base-proj/
 | | - index.html
 | | - style.css
 | - src/
-| | - main/             //- Electron / backend modules
+| | - main/             //- Backend modules for the Electron app
 | | | - main.ts         //- Entry point of 'electron-main'
 | | - models/
-| | - renderer/         //- React / frontend components
+| | - renderer/         //- Frontend React components for the Electron app
 | | | - renderer.tsx    //- Entry point of 'electron-renderer'
 | | - utils/            //- Common utilities
 | - test/               //- Unit tests
+| - .eslintrc           //- ESLint config
 | - .gitignore
 | - package-lock.json
 | - package.json
@@ -59,7 +111,6 @@ electron-react-typescript-base-proj/
 | - webpack.config.js   //- Webpack config
 ```
 
-## **License**
-
+## License
 Electron React TypeScript Webpack Boilerplate is open source software 
 [licensed as MIT](LICENSE).