Skip to content

Commit

Permalink
GITBOOK-172: Add note for Yarn Classic usage
Browse files Browse the repository at this point in the history
  • Loading branch information
erickzhao authored and gitbook-bot committed Oct 21, 2023
1 parent ca19ed2 commit 2e82937
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ Electron Forge is an all-in-one tool for packaging and distributing Electron app

To get started with Electron Forge, we first need to initialize a new project with `create-electron-app`. This script is a convenient wrapper around Forge's [Init](cli.md#Init) command.

{% hint style="warning" %}
Electron Forge 6 works best with Yarn Classic (v1.x) and npm. If you are using a newer version of Yarn, you can downgrade to Classic using the [`yarn set version`](https://yarnpkg.com/cli/set/version) command.
{% endhint %}

{% tabs %}
{% tab title="Yarn" %}
```bash
Expand Down Expand Up @@ -59,7 +63,7 @@ There are currently two first-party templates:
* `webpack`
* `webpack-typescript`

Both of these templates are built around the [Webpack Plugin](/config/plugins/webpack.md), which bundles your JavaScript code for production and includes a dev server to provide a better development experience. The `webpack-typescript` template also wires up your project for TypeScript support.
Both of these templates are built around the [Webpack Plugin](config/plugins/webpack.md), which bundles your JavaScript code for production and includes a dev server to provide a better development experience. The `webpack-typescript` template also wires up your project for TypeScript support.

{% hint style="info" %}
We highly recommend using these templates when initializing your app to take advantage of modern front-end JavaScript tooling.
Expand Down

0 comments on commit 2e82937

Please sign in to comment.