Skip to content

Commit 8cdc6da

Browse files
committed
spelling & sentence flow
1 parent 29b2e51 commit 8cdc6da

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

resources/views/docs/desktop/2/getting-started/upgrade-guide.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,14 @@ order: 1200
1414
- [Serve command renamed](#renamed-codenativeservecode-command)
1515
- [Node integration disabled by default](#security-defaults)
1616

17-
## Upgrading To 2.0 From 1.x
17+
### Low Impact Changes
18+
19+
- [Modifying the Electron backend](#modifying-the-electron-backend)
1820

19-
NativePHP for Desktop v2 is a significant architecture overhaul & security release. The package has moved to a new repository with a new name; `nativephp/desktop`.
21+
## Upgrading To 2.0 From 1.x
2022

21-
Please replace `nativephp/electron` from your `composer.json` with the new package.
23+
NativePHP for Desktop v2 is a significant architecture overhaul and security release. The package has moved to a new repository with a new name: `nativephp/desktop`.
24+
Please replace `nativephp/electron` in your `composer.json` with the new package.
2225

2326
```json
2427
"require": {
@@ -29,21 +32,20 @@ Please replace `nativephp/electron` from your `composer.json` with the new packa
2932
```
3033

3134
If you're requiring `nativephp/laravel` as well, please remove that too.
35+
Then run `composer update` and `php artisan native:install` and you're good to go.
3236

33-
Then run `composer update` & `php artisan native:install` and you're good to go.
34-
35-
Afterwards the `native:install` script will be automatically installed as a `post-update-cmd`, so you won't have to manually run it after a composer update.
37+
After installation, the `native:install` script will be automatically registered as a `post-update-cmd`, so you won't have to manually run it after a composer update.
3638

3739
## Update class imports
3840

39-
With the package rename the root namespace has also changed. Please update all occurances of `Native\Laravel` to `Native\Desktop`.
41+
With the package rename, the root namespace has also changed. Please update all occurrences of `Native\Laravel` to `Native\Desktop`.
4042

4143
```php
4244
use Native\Laravel\Facades\Window; // [tl! remove]
4345
use Native\Desktop\Facades\Window; // [tl! add]
4446
```
4547

46-
## MacOS support
48+
## macOS support
4749

4850
v2 drops support for macOS **_Catalina_** and **_Big Sur_**. This change comes from the Electron v38 upgrade and aligns with Apple's supported OS versions. Most users should be unaffected, but please check your deployment targets before upgrading.
4951

@@ -58,3 +60,9 @@ Please update the `composer native:dev` command to use the new name.
5860
## Security defaults
5961

6062
`nodeIntegration` is now disabled by default. While this improves security, it may affect applications that rely on this functionality. You can easily re-enable it using `Window::webPreferences()` where needed.
63+
64+
## Modifying the Electron backend
65+
66+
If you need to make any specific adjustments to the underlying Electron app, you can publish it using `php artisan native:install --publish`. This will export the Electron project to `{project-root}/nativephp/electron` and allow you to fully control all of NativePHP's inner workings.
67+
68+
Additionally, this will modify your `post-update-cmd` script to keep your project up to date, but note that you may need to cherry-pick any adjustments you've made after a `composer update`.

0 commit comments

Comments
 (0)