Skip to content

Commit

Permalink
Update docs to match new behaviour after removing gulp
Browse files Browse the repository at this point in the history
  • Loading branch information
Hinton committed Nov 8, 2024
1 parent 3463505 commit 2814128
Showing 1 changed file with 11 additions and 22 deletions.
33 changes: 11 additions & 22 deletions docs/getting-started/clients/browser/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,14 @@ Before you start, you must complete the [Clients repository setup instructions](

## Build Instructions

1. Build and run the extension:
1. Build and run the extension, this command differs depending on the browser you are building for.

```bash
cd apps/browser
npm run build:watch
```

:::note
npm run build:watch:chrome

The build commands use
[Manifest v3](https://developer.chrome.com/docs/extensions/develop/migrate/what-is-mv3) by
default. If you are building for Firefox or otherwise need a Manifest v2 build, you should use
the command `npm run build:watch:mv2` instead.

:::
# Replace chrome with "edge", "firefox", "opera" or "safari" to build for other browsers.
```

2. Load the unpacked browser extension in your browser using the instructions in the next section.

Expand Down Expand Up @@ -194,15 +187,11 @@ The easiest way to develop the extension is to build and debug it using Xcode.
1. Build the extension:

```bash
npm run build:watch:mv2
npm run build:watch:safari
```

2. Edit `build/manifest.json`. Move the `nativeMessaging` permission from the `optional_permissions`
section into the `permissions` section
3. Edit `build/popup/index.html`, replace `<html class="__BROWSER__">` to
`<html class="browser_safari">`.
4. Open `src/safari/desktop.xcodeproj` in Xcode
5. Run the "desktop" target.
2. Open `src/safari/desktop.xcodeproj` in Xcode
3. Run the "desktop" target.

:::note

Expand All @@ -213,14 +202,14 @@ not automatically reload.

#### Production build

The other alternative is to use the "proper" build process through gulp. This method doesn't require
any manual processing of the output since gulp does it for us. However we have to completely rebuild
the extension for every change, which is slower.
The other alternative is to use the "proper" build process. This method doesn't require manually
opening Xcode, however we have to completely rebuild the extension for every change, which is
slower.
1. Build the extension for Safari
```bash
npm run dist:safari:dmg
npm run dist:safari
```
2. Open Safari and check Settings to confirm that the extension is installed and enabled
Expand Down

0 comments on commit 2814128

Please sign in to comment.