Skip to content

Commit

Permalink
chore: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
VerteDinde committed Oct 26, 2022
1 parent 9b29257 commit 1002b31
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions packages/external/create-electron-app/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## create-electron-app

Create Electron App allows you to quickly bootstrap a new Electron app, using Electron Forge.

### Usage

Initialize a new project by running the following:

```
// yarn 1
yarn create electron-app my-app
// npm
npx create-electron-app@latest my-app
```

You should now have a directory called my-app with an ultra-minimal Electron app boilerplate inside. If you head into that directory and start up the app, you'll be all set to start developing!

```
// yarn 1
cd my-app
yarn start
// npm
cd my-app
npm start
```

0 comments on commit 1002b31

Please sign in to comment.