diff --git a/README.md b/README.md new file mode 100644 index 0000000..5146ded --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# electron-webpack-quick-start +> A bare minimun project structure to get started developing with `electron-webpack`. + +Thanks to the power of `electron-webpack` this template comes packed with... + +* Use of [`webpack-dev-server`](https://github.com/webpack/webpack-dev-server) for development +* HMR for both `renderer` and `main` processes +* Use of [`babel-preset-env`](https://github.com/babel/babel-preset-env) that is automatically configured based on your `electron` version +* Use of [`electron-builder`](https://github.com/electron-userland/electron-builder) to package and build a distributable electron application + +Make sure to check out [`electron-webpack`'s documentation](https://webpack.electron.build/) for more details. + +## Getting Started +Simply clone down this reposity, install dependencies, and get started on your application. + +The use of the [yarn](https://yarnpkg.com/) package manager is strongly recommended, as opposed to using `npm`. + +```bash +# copy template using curl +curl -fsSL [repoLink]/archive/master.tar.gz | tar -xz --strip-components 2 + +# or copy template using git clone +git clone [repoLink] +cd electron-webpack-quick-start +rm -rf .git + +# install dependencies +yarn +``` + +### Development Scripts + +```bash +# run application in development mode +yarn dev + +# compile source code and create webpack output +yarn compile + +# create build with electron-builder +yarn dist + +# create unpacked build with electron-builder +yarn dist:dir +```