Skip to content

Commit b86996c

Browse files
committed
Update intro
- Rewrote the introduction part to make it more clear to new users on things those this boilerplate does.
1 parent bb373f8 commit b86996c

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

README.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
11
# Electron-React-TypeScript-Webpack-Boilerplate
2-
Pre-configured Electron.js + React.js + TypeScript boilerplate with
3-
Webpack, Jest & ESLint config predefined.
2+
A boilerplate that let you instantly start working on your next [Electron] app
3+
in [TypeScript] with no time wasted messing with the config files.
44

5-
This boilerplate has been tested on latest macOS and Windows. If anything
6-
doesn't work, please [file an issue](https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/issues/new).
5+
- Ready to use [Electron] project template with [React], [Webpack] and
6+
[TypeScript] seamlessly integrated.
7+
- [ESLint] set up with TypeScript, Airbnb's rules, and [Jest] support.
8+
- [Jest] integrated and configured.
9+
- [`electron-builder`] for app packaging, with basic build config for Windows
10+
macOS included.
11+
- Clean, easy to read and alter config files. No config file is hidden behind
12+
yet another script!
13+
14+
*This boilerplate is tested on the latest macOS and Windows. If anything
15+
doesn't work, please [file an issue].*
716

817
## Getting started
918
1. Clone this repository, or if you're hosting your Electron project on GitHub,
@@ -112,9 +121,16 @@ gonna be a great motivation for me.
112121
Electron React TypeScript Webpack Boilerplate is open source software
113122
[licensed as MIT](LICENSE).
114123
124+
[Electron]: https://www.electronjs.org
125+
[React]: https://reactjs.org
126+
[Webpack]: https://webpack.js.org
127+
[TypeScript]: https://www.typescriptlang.org
128+
[ESLint]: http://eslint.org
129+
[Jest]: https://jestjs.io
130+
[`electron-builder`]: https://github.com/electron-userland/electron-builder
131+
[file an issue]: https://www.electronjs.org
115132
[`Use this template`]: https://github.com/Devtography/electron-react-typescript-webpack-boilerplate/generate
116133
[Electron quick start guide]: https://www.electronjs.org/docs/latest/tutorial/quick-start
117-
[`electron-builder`]: https://github.com/electron-userland/electron-builder
118134
[Electron Forge]: https://github.com/electron-userland/electron-forge
119135
[`electron-builder`'s document]: https://www.electron.build
120136
[notarization requirements]: https://developer.apple.com/news/?id=04102019a

0 commit comments

Comments
 (0)