Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add publish command to getting started #163

Merged
merged 6 commits into from
Mar 5, 2024
Merged

docs: add publish command to getting started #163

Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e114f66
docs: update getting started (#1)
Sankalp2114 Feb 28, 2024
c10e2e7
Update README.md
erickzhao Mar 5, 2024
428f131
Update README.md
erickzhao Mar 5, 2024
45829e9
Update README.md
erickzhao Mar 5, 2024
fb04e62
Update README.md
erickzhao Mar 5, 2024
51e2fdd
Update README.md
erickzhao Mar 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,10 @@ npm init electron-app@latest my-app -- --template=webpack

There are currently four first-party templates:

* `webpack`
* `webpack-typescript`
* `vite`
* `vite-typescript`
- `webpack`
- `webpack-typescript`
- `vite`
- `vite-typescript`

Both of these templates are built around plugins that bundle your JavaScript code for production and includes a dev server to provide a better developer experience.

Expand Down Expand Up @@ -62,18 +62,26 @@ npm run make

## Publishing your app

Now you have distributables that you can share with your users. If you run the `publish` script, Electron Forge will then publish the platform-specific distributables for you, using the publishing method of your choice. For more information on what publishers we currently support, check out the [Publishers](config/publishers/) documentation.
Now you have distributables that you can share with your users. If you run the `publish` script, Electron Forge will then publish the platform-specific distributables for you, using the publishing method of your choice. For example, if you are using GitHub as a publisher, you can install it using:

```bash
npm install -D @electron-forge/publisher-github
```

And then run

```bash
npm run publish
```

For more information on what publishers we currently support, check out the [Publishers](config/publishers/) documentation.

## Advanced Usage

Once you've got a basic app starting, building and publishing, it's time to add your custom configuration, which can be done in the `forge.config.js` file. Configuration options are specified in the [Configuration Docs](https://www.electronforge.io/configuration).

You can also check out the documentation on some of our more advanced features like:

* [Adding plugins](config/plugins/)
* [Debugging your app](advanced/debugging.md)
* [Writing your own makers, publishers and plugins](advanced/extending-electron-forge/)
- [Adding plugins](config/plugins/)
- [Debugging your app](advanced/debugging.md)
- [Writing your own makers, publishers and plugins](advanced/extending-electron-forge/)