Skip to content

armgit / plexo

Public Imported from GitHub
0

Speed up downloads by combining multiple network connections in parallel

Update README and docs (#137)

Anmol Kapil5bedb9bc3a7d
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
index a865282..9bbed0e 100644
--- a/.github/FUNDING.yml
+++ b/.github/FUNDING.yml
@@ -1 +1,2 @@
github: anmolkapil
+ko_fi: I5Q128RXSP
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 319acf2..e452398 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -7,19 +7,35 @@ Thanks for taking a look at Plexo. It's a small project, so the process is inten
```bash
git clone https://github.com/anmolkapil/plexo.git
cd plexo
-npm install
+npm ci
npm run dev
```
-Requires Node.js 22.12+ and npm 9+, on Windows, macOS, or Linux.
+Requires Node.js 22.13+ and npm 9+, on Windows, macOS, or Linux.
## Packaging
-- **macOS**: `npm run build:mac` writes `dist/mac/Plexo.app`. A build made on your own Mac isn't quarantined, so it opens without the first-launch step.
-- **Windows**: `npm run build:win`, from PowerShell, writes the installer to `dist/`. For an app you run without installing, use `npm run build:unpack` and open `dist/win-unpacked/plexo.exe`.
-- **Linux**: `npm run build:linux` writes the AppImage and `.deb` packages to `dist/`
+Run packaging commands on the corresponding operating system. Packages are written to `dist/`.
-Local builds are unsigned.
+- **macOS**: `npm run build:mac` creates Intel and Apple silicon `.dmg` and `.zip` packages. Unpacked apps are in `dist/mac/Plexo.app` and `dist/mac-arm64/Plexo.app`.
+- **Windows**: `npm run build:win` creates one installer for x64 and ARM64. `npm run build:unpack` creates an unpacked app for the current architecture; run `dist/win-unpacked/plexo.exe`.
+- **Linux**: `npm run build:linux` creates AppImage, `.deb` and `.rpm` packages for x86_64 and ARM64. RPM packaging requires `rpmbuild`; the release workflow installs it through the `rpm` package.
+
+Local builds are unsigned unless signing credentials are configured.
+
+## Browser extension
+
+Build both browser variants:
+
+```bash
+npm run build:extension
+```
+
+For Chrome, enable **Developer mode** at `chrome://extensions`, choose **Load unpacked**, and select `extension/dist/chrome`.
+
+For Firefox, open `about:debugging#/runtime/this-firefox`, choose **Load Temporary Add-on**, and select `extension/dist/firefox/manifest.json`. Temporary add-ons are removed when Firefox restarts.
+
+Keep Plexo running to test download capture. Rebuild and reload the extension after changing its source.
## Before opening a PR
@@ -38,10 +54,16 @@ Please describe how you checked your change manually (which URL/file size/interf
## End-to-end tests
+On Linux, Electron needs a display even when the test window is hidden. In a headless environment, install Xvfb and run:
+
+```bash
+xvfb-run --auto-servernum --server-args="-screen 0 1280x1024x24 -noreset" npm run test:e2e:smoke
+```
+
`e2e/` drives the real built app through the same `window.plexo` API the renderer uses, against a local test server that can drop, stall, corrupt or hold any response at an exact byte. Every test also runs automatic checks: a `completed` download must match the source byte for byte, and anything else must leave no file, part files or open handles behind. The app's window stays hidden while tests run.
```bash
-npm run test:e2e:smoke # what CI runs on every PR (~1 min)
+npm run test:e2e:smoke # smoke tests run on every PR
npm run test:e2e # everything, including @disk and @chaos
PLEXO_CHAOS_RUNS=50 npx playwright test e2e/chaos.spec.ts # more random sequences
PLEXO_CHAOS_SEED=<seed> npx playwright test e2e/chaos.spec.ts # replay a chaos failure
@@ -58,7 +80,7 @@ Tests build the app first; set `PLEXO_E2E_SKIP_BUILD=1` when `out/` is already f
## Releasing
-A release ships seven files: `Plexo` for macOS (Apple silicon and Intel `.dmg`), Windows (one installer for x64 and ARM64) and Linux (`AppImage` and `.deb`, x86_64 and ARM64). The download page (`docs/`, served by GitHub Pages) reads them from the latest GitHub Release and labels each one from its file name (`docs/downloads.js`), so keep the naming in `electron-builder.yml` intact.
+A release ships Plexo for macOS (Apple silicon and Intel `.dmg`), Windows (one installer for x64 and ARM64) and Linux (AppImage, `.deb` and `.rpm`, x86_64 and ARM64). The download page (`docs/`, served by GitHub Pages) reads them from the latest GitHub Release and labels each one from its file name (`docs/downloads.js`), so keep the naming in `electron-builder.yml` intact.
First bump the version and add its entry at the top of `docs/changelog.js`, in one PR. The entry becomes the release notes, and a tag without one stops before building.
diff --git a/README.md b/README.md
index 199c553..e62a2ac 100644
--- a/README.md
+++ b/README.md
@@ -1,220 +1,198 @@
-# Plexo
-
-[![Sponsor](https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?logo=githubsponsors)](https://github.com/sponsors/anmolkapil)
-
-Plexo is a download manager for Windows, macOS, and Linux that downloads one file over several internet connections at the same time. If your computer has Wi-Fi and a phone tethered over USB, Plexo uses both for the same download. It handles direct links, magnet links, and `.torrent` files, with a queue, a downloads list, and speed and data limits for each network.
+<p align="center">
+ <img src="build/icon.png" width="128" alt="Plexo icon">
+</p>
+
+<h1 align="center">Plexo</h1>
+
+<p align="center">
+ Download files and torrents faster by combining all your internet connections.<br>
+ Plexo combines Wi-Fi, Ethernet, mobile networks, and other available connections to boost your download speeds.
+</p>
+
+<p align="center">
+ <a href="https://getplexo.app">Download</a> ·
+ <a href="#features">Features</a> ·
+ <a href="#troubleshooting">Troubleshooting</a> ·
+ <a href="#how-it-works">How it works</a> ·
+ <a href="#build-from-source">Build</a>
+</p>
+
+<p align="center">
+ <a href="https://github.com/anmolkapil/plexo/releases/latest"><img src="https://img.shields.io/github/v/release/anmolkapil/plexo?label=release" alt="Latest release"></a>
+ <a href="https://github.com/anmolkapil/plexo/releases"><img src="https://img.shields.io/github/downloads/anmolkapil/plexo/total" alt="Downloads"></a>
+ <a href="https://github.com/anmolkapil/plexo/actions/workflows/ci.yml"><img src="https://github.com/anmolkapil/plexo/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI status"></a>
+ <a href="https://getplexo.app/#downloads"><img src="https://img.shields.io/badge/platform-macOS%20%7C%20Windows%20%7C%20Linux-black" alt="macOS, Windows and Linux"></a>
+ <a href="LICENSE"><img src="https://img.shields.io/github/license/anmolkapil/plexo" alt="MIT license"></a>
+</p>
+
+<p align="center">
+ <a href="https://ko-fi.com/I5Q128RXSP"><img src="https://ko-fi.com/img/githubbutton_sm.svg" alt="Buy me a coffee on Ko-fi"></a>
+</p>
+
+<p align="center">
+ For anything private, email <a href="mailto:[email protected]"><strong>[email protected]</strong></a>
+</p>
+
+<p align="center">
+ <a href="https://trendshift.io/repositories/240800?utm_source=trendshift-badge&amp;utm_medium=badge&amp;utm_campaign=badge-trendshift-240800" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/240800/daily?language=TypeScript" alt="anmolkapil%2Fplexo | Trendshift" width="250" height="55"/></a>
+ <a href="https://trendshift.io/repositories/240800?utm_source=trendshift-badge&amp;utm_medium=badge&amp;utm_campaign=badge-trendshift-240800" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/240800/daily" alt="anmolkapil%2Fplexo | Trendshift" width="250" height="55"/></a>
+ <a href="https://trendshift.io/repositories/240800?utm_source=trendshift-badge&amp;utm_medium=badge&amp;utm_campaign=badge-trendshift-240800" target="_blank" rel="noopener noreferrer"><img src="https://trendshift.io/api/badge/trendshift/repositories/240800/weekly?language=TypeScript" alt="anmolkapil%2Fplexo | Trendshift" width="250" height="55"/></a>
+</p>
https://github.com/user-attachments/assets/e57728f4-fb63-441f-839c-174eef954b17
-## Download Plexo
-
-Get the installer for your computer from [getplexo.app](https://getplexo.app/#downloads), or pick a file from [GitHub Releases](https://github.com/anmolkapil/plexo/releases). Builds are available for macOS (Apple silicon and Intel), Windows 10 and 11 (x64 and ARM64), and Linux (AppImage and `.deb`, x86_64 and ARM64).
-
-The Mac app is signed with an Apple Developer ID (see [Credits](#credits)) and notarized by Apple, so it opens like any other app. On Windows, the first launch needs one extra step: when it shows "Windows protected your PC", click **More info**, then **Run anyway**. The installer isn't code-signed yet.
-
-Plexo updates itself after that: new versions download in the background and install when you restart.
-
-## What Plexo does
-
-Plexo splits each download across every network you select, so a second connection adds to your speed instead of sitting idle.
-
-### Direct downloads
-
-- **Several networks, many streams each**: a file is split into blocks of up to 8 MB that streams on every network fetch in parallel. Each network starts with 8 streams and doubles to 16 and 32 once they're all receiving. Downloads running at once share those 32. You can also pick a fixed 4, 8, 16, or 32 in the **New download** dialog.
-- **Faster networks do more of the work**: a stream takes the next block as soon as it's free, so a fast network fetches more blocks than a slow one.
-- **No slow finish**: near the end, a free stream races a slow block from where it got to, and the first to finish wins
-- **Pause and resume**: progress is saved as you go. Before resuming, Plexo checks the file on the server hasn't changed, and refuses rather than mixing two versions.
-- **Survives restarts and sleep**: a download running when Plexo quits comes back paused. Streams restart as soon as the computer wakes or a network gets a new address, and Plexo keeps the computer awake while a download runs.
-- **Fix expired links**: paste a fresh link to the same file and the download carries on from where it stopped
-- **Backs off when a server asks**: if a server refuses some streams (403, 429, 503, or no answer), that network drops to the streams it accepted, then gets one more back each minute
-
-### Torrents
+## Features
-- **Magnet links and `.torrent` files**: paste a link or open a file in Plexo. You can also open a `.torrent` with Plexo from your file manager, and on macOS and Linux, a magnet link from your browser. Plexo never makes itself the default over a torrent client you already have.
-- **Choose files**: pick which files to download before it starts, and change your choice while it runs
-- **Peers spread across networks**: each new peer connects through the network with the fewest. Switching a network off moves its peers to the others.
-- **Uploads on every network**: peers get pieces back over each network, USB-tethered ones included, so they keep sending to you
+### Multi-network downloads
-### Queue and downloads list
+- Combine multiple internet connections for faster downloads
+- Enable or disable networks during a download
+- Rename networks and customize their colors
+- Download file chunks in parallel across connections
+- Balance chunks across connections, with faster networks handling more of the download
+- Automatically adjust parallel streams to network, server and disk performance
+- Race slow chunks on idle connections to avoid a slow finish
+- View live speeds, time remaining and per-network progress
-- **Queue**: two downloads run at once by default, and you can set one to eight. The rest wait and start on their own when a slot opens.
-- **Downloads list**: downloads are grouped as Downloading, Queued, Paused, Needs attention, and Finished, and finished downloads stay in the list after a restart
-- **Actions on several downloads at once**: select downloads to pause, resume, retry, cancel, remove them from the list, or move their files to Trash
-- **Links from the clipboard**: opening **New download** fills in a link you've copied
+### Browser integration
-### Limits and networks
+- Capture downloads or send individual links to Plexo
+- Download files using your browser’s authenticated session
+- Exclude websites and skip small files
-- **Speed limits**: a total limit for all downloads, a per-network limit, and **Slow mode**, a one-click lower limit (2 MB/s by default) for when you're on a call
-- **Data limits**: a daily, weekly, or monthly allowance per network. Plexo stops using a network once its allowance is used up.
-- **Named networks**: Plexo shows adapters by their real names (Wi-Fi, Ethernet, iPhone) instead of `en0`. You can rename and recolor them.
-- **Live view**: throughput charts, time left, per-stream stats, and a grid of every block colored by the network that fetched it
+### Download management
-## Set up more than one network
+- Download direct links, magnet links and `.torrent` files
+- Select torrent files before or during a download
+- Pause and resume supported downloads across restarts
+- Automatically reconnect downloads after sleep
+- Replace expired links without losing progress
+- Queue downloads and configure concurrent downloads
+- Pause, resume, retry or remove downloads in bulk
-Plexo adds speed only when each network reaches the internet through its own connection. Wi-Fi from your home router plus a phone tethered over USB works. Wi-Fi and Ethernet plugged into the same router doesn't: both share the router's single connection, so the total stays the same.
+### Bandwidth controls
-Plexo can only use a connection your operating system shows as a network adapter. Two setups need an extra step:
+- Set global and per-network speed limits
+- Switch to Slow mode for calls and streaming
+- Set daily, weekly or monthly data allowances
+- Schedule downloads by time and day
-- **Windows turns Wi-Fi off when Ethernet is plugged in**: open the Group Policy Editor (`gpedit.msc`), go to _Computer Configuration_ › _Administrative Templates_ › _Network_ › _Windows Connection Manager_, and set **Minimize the number of simultaneous connections to the Internet or a Windows domain** to **Disabled**
-- **An Android phone over USB on macOS**: macOS has no driver for Android's USB tethering. Install TetherKit, as described in [Use an Android phone over USB on macOS](#use-an-android-phone-over-usb-on-macos).
+## Troubleshooting
-On Windows, install your phone maker's driver if the phone doesn't appear in Network Settings. An adapter appearing in Plexo doesn't guarantee it reaches the internet: VPN, virtual, and isolated adapters show up too. Check each network's latency and speed in Plexo.
+If your problem isn't covered here, [open an issue](https://github.com/anmolkapil/plexo/issues).
-## Manage your downloads
+<details>
+<summary><strong>Windows says "Windows protected your PC"</strong></summary>
+<br>
-The menu in the header filters the list to **All downloads**, **In progress**, **Finished**, or **Needs attention**. Click a download's name to see its progress in detail.
+The installer isn't code-signed yet. Click **More info**, then **Run anyway**.
-Tick downloads to select them, or use **Select all** for the filtered list. The header then shows each action with how many of the selected downloads it applies to:
+</details>
-- **Pause** downloading or queued downloads, and **Resume** paused ones
-- **Retry** downloads that failed and can recover. A download whose link expired has its own **Fix link** button, and one that can't resume has **Download again**.
-- **Remove from list** takes finished downloads off the list and leaves their files on your computer. **Clear finished list** does this for every finished download.
-- **Cancel downloads…** stops unfinished downloads and deletes what they downloaded so far
-- **Move files to Trash…** moves finished downloads' files to the Trash, or the Recycle Bin on Windows. For a torrent, Plexo moves only the files it downloaded and leaves anything else you added to the folder.
+<details>
+<summary><strong>A second network doesn't make downloads faster</strong></summary>
+<br>
-Cancel and Move to Trash ask you to confirm first.
+Plexo adds speed only when each network reaches the internet through its own connection. Wi-Fi from your home router plus a phone tethered over USB works. Wi-Fi and Ethernet plugged into the same router doesn't: both share one connection, so the total stays the same.
-## Set speed and data limits
+VPN, virtual, and isolated adapters show up in Plexo too, so check each network's latency and speed there.
-Open **Speed & data limits…** from the networks menu. Changes apply as you make them.
+</details>
-Under **All downloads**, set the total speed limit, the Slow mode speed, and how many downloads run at once. While Slow mode is on, its speed replaces the total limit, and per-network limits still apply.
+<details>
+<summary><strong>A network doesn't appear in Plexo</strong></summary>
+<br>
-Choose a network to set its speed limit in KB/s or MB/s, and its data allowance in GB per **Day**, **Week**, or **Month**. The allowance counts what Plexo downloads on that network, torrents included; uploads and other apps don't count. Days reset at midnight, weeks on Monday, and months on the 1st, all in your local time, and usage is kept across restarts.
+Plexo can use any connection your operating system shows as a network adapter.
-Two buttons manage a network's limits, and both ask you to confirm:
-
-- **Reset data usage…** sets the network's usage for the current period back to zero, so a network that hit its allowance can be used again
-- **Remove limits…** clears the network's speed and data limits and keeps its recorded usage
-
-## Schedule overnight downloads
-
-Open **Networks → Speed & data limits… → All downloads** and find **Download schedule**. Enable the schedule, choose start and stop times in your computer’s local time, pick repeat days, and optionally set an end date. For a free-data window from midnight to 7 AM, use **00:00** and **07:00**.
-
-Outside those hours, new downloads and downloads you resume wait in the queue. At the stop time, active downloads and torrent uploads stop, keeping progress for the next window. Downloads you pause yourself stay paused. Scheduled work survives restarting Plexo; when the end date passes, it stays waiting until you change or disable the schedule. Disabling the schedule lets the queue start immediately.
-
-For a window crossing midnight, repeat days and the end date refer to the day it starts. Keep Plexo running and the computer awake for the scheduled start; Plexo keeps the computer awake while downloading, but does not wake a sleeping computer. Checking links and fetching magnet metadata when adding downloads can still use data outside the scheduled hours. The schedule controls Plexo’s transfers, not other apps or Plexo’s update check.
-
-## How Plexo combines networks
-
-Your operating system sends all of a computer's traffic through one default connection and leaves the others idle. Plexo opens its own connections on each network you select, and downloads different parts of the file on each.
-
-```text
- ┌── Wi-Fi (192.168.1.40) ──────┐
- │ │
-File ──→ Split ─────┼── Ethernet (10.0.0.12) ──────┼──→ Assembled file
- │ │
- └── USB tether (172.20.10.3) ──┘
-```
+- **iPhone on macOS**: in **System Settings › Network**, open **iPhone USB** and turn off **Disable unless needed**
+- **Android on macOS**: install TetherKit, as described below
+- **Phone on Windows**: install your phone maker's driver if the phone doesn't appear in Network Settings
-It needs no virtual adapter, VPN, kernel extension, or administrator rights.
+</details>
-### Direct downloads use HTTP range requests
+<details>
+<summary><strong>Windows uses only one network</strong></summary>
+<br>
-Most servers can send any slice of a file on request. A request with `Range: bytes=8388608-16777215` gets back bytes 8 MB to 16 MB with status `206 Partial Content`. Plexo first asks for a single byte. A `206` answer proves the server supports ranges and tells Plexo the file's size, name, and version (`ETag` and `Last-Modified`). A server that ignores ranges gets an ordinary single-stream download.
+If Windows turns Wi-Fi off when Ethernet is plugged in, open the Group Policy Editor (`gpedit.msc`), go to _Computer Configuration_ › _Administrative Templates_ › _Network_ › _Windows Connection Manager_, and set **Minimize the number of simultaneous connections to the Internet or a Windows domain** to **Disabled**.
-Each stream connects from one network's own address, so its traffic goes out through that network. On Linux, Plexo also pins the socket to the network device.
+If both stay connected but one sits idle in Plexo, Windows may be sending its traffic out the other network. Add your setup to [#65](https://github.com/anmolkapil/plexo/issues/65).
-```typescript
-https.request({
- hostname: 'releases.ubuntu.com',
- path: '/ubuntu-26.04.1-desktop-amd64.iso',
- localAddress: '172.20.10.3', // the USB tether's address
- headers: { Range: 'bytes=8388608-16777215' }
-})
-```
+</details>
-### Streams share one queue of blocks
+<details>
+<summary><strong>A network stays idle after reconnecting a phone</strong></summary>
+<br>
-Splitting a file into equal halves, one per network, makes the download only as fast as the slower network. Plexo cuts the file into blocks of up to 8 MB instead, and puts them all in one queue:
+Pause the download, then resume it.
-1. Each stream takes the next block in the queue, fetches it, then takes another. It keeps its connection to the server open between blocks, so it connects only once.
-2. A faster network finishes its blocks sooner and takes more of them. If a network slows down or drops, the others keep draining the queue.
-3. Once the queue is empty, a free stream can race a block that another stream is fetching too slowly. The first to finish wins. The streams table marks the racing stream **BACKUP**.
+</details>
-8 MB keeps the queue balanced between mismatched networks, and caps what a failed stream throws away. Small files get smaller blocks, never under 1 MB, so every stream has at least two.
+<details>
+<summary><strong>Downloads to a hard drive are slow</strong></summary>
+<br>
-Each block is written straight to its place in `<filename>.plexo`, a staging file next to the destination. When every block is in, Plexo renames it to the final name, picking a numbered name if that one is taken. The destination needs room for one copy of the file.
+Leave **Streams** on **Auto** in **New download**. Auto lowers the streams when the disk can't keep up; a fixed number doesn't.
-### Torrents pin each peer to a network
+</details>
-Plexo runs torrents with [WebTorrent](https://github.com/webtorrent/webtorrent) and opens every peer connection from one network's address. To keep every peer on a network Plexo chose, it turns off the parts that would connect on their own: uTP, WebRTC, web seeds, UPnP and NAT-PMP port mapping, and local peer discovery. Peers are found through HTTP/UDP trackers and the DHT. Torrents that are v2-only aren't supported yet.
+### Use an Android phone over USB on macOS
-### Resuming checks the file hasn't changed
+macOS has no driver for RNDIS, the protocol Android's USB tethering uses, so the phone charges but no network adapter appears. [TetherKit](https://github.com/XiaoMiku01/TetherKit) is an open-source app that adds one without a kernel extension.
-Pausing closes every connection and keeps the staging file plus a small progress record in Plexo's app data. Resuming asks the server for the file's `ETag` and `Last-Modified` again. If they match, each block continues from the last saved byte. If they don't, the file changed on the server, and Plexo refuses to resume instead of joining two versions into a corrupt file.
+1. Install TetherKit: `brew install XiaoMiku01/tap/tetherkit`
+2. Connect your phone over USB.
+3. On the phone, open **Settings › Network & internet › Hotspot & tethering** and turn on **USB tethering**.
+4. Open TetherKit. On first run, approve its helper with your password.
+5. Pick your phone, click **Connect**, then apply the IP settings.
+6. Open Plexo. The phone appears in the networks list.
-## Use an Android phone over USB on macOS
+Thanks to [@XiaoMiku01](https://github.com/XiaoMiku01) for building and open-sourcing TetherKit.
-macOS has no driver for RNDIS (Remote Network Driver Interface Specification), the protocol Android's USB tethering uses. The phone charges, but no network adapter appears. [TetherKit](https://github.com/XiaoMiku01/TetherKit) is an open-source driver that runs without a kernel extension and adds one.
+## How it works
-1. Install TetherKit:
+Plexo downloads different parts of the same file through each internet connection you select, then assembles them on disk.
- ```bash
- brew install XiaoMiku01/tap/tetherkit
- ```
+For direct downloads, Plexo uses HTTP range requests to fetch chunks in parallel. Streams take new chunks from a shared queue as they finish, so faster connections handle more of the file. Plexo adjusts stream counts to network, server and disk performance. Near the end, idle streams can race slow chunks; the first to finish wins. Servers without range support use a single stream.
-2. Connect your phone over USB.
-3. On the phone, open **Settings › Network & internet › Hotspot & tethering** and turn on **USB tethering**.
-4. Open Plexo. The phone appears in the networks list.
+For torrents, Plexo distributes peer connections across your selected networks. New peers connect through the network with the fewest peers.
-Thanks to [@XiaoMiku01](https://github.com/XiaoMiku01) for building and open-sourcing TetherKit.
+Each network needs its own internet connection to add bandwidth. Plexo combines connections for its own downloads and requires no VPN or virtual network adapter.
-## Build Plexo from source
+## Build from source
-You need Node.js 22.12 or later and npm 9 or later.
+You need Node.js 22.13 or later and npm 9 or later.
```bash
git clone https://github.com/anmolkapil/plexo.git
cd plexo
-npm install
+npm ci
npm run dev
```
-Run the end-to-end tests with Playwright. [CONTRIBUTING.md](CONTRIBUTING.md#end-to-end-tests) covers the options and debugging flags.
-
-```bash
-npm run test:e2e:smoke # smoke tests
-npm run test:e2e # the full suite
-```
+| Command | What it does |
+| ------------------------- | ------------------------------------------------------------- |
+| `npm run test:e2e:smoke` | Playwright smoke tests |
+| `npm run test:e2e` | The full end-to-end suite |
+| `npm run build:mac` | Creates macOS packages in `dist/` |
+| `npm run build:win` | Creates the Windows installer in `dist/` |
+| `npm run build:unpack` | Creates an unpacked app for the current platform in `dist/` |
+| `npm run build:linux` | Creates AppImage, `.deb` and `.rpm` packages in `dist/` |
+| `npm run build:extension` | Builds the Chrome and Firefox extensions in `extension/dist/` |
-Package the app for each platform:
-
-- **macOS**: `npm run build:mac` writes `dist/mac/Plexo.app`. A build made on your own Mac isn't quarantined, so it opens without the first-launch step.
-- **Windows**: `npm run build:win`, from PowerShell, writes the installer to `dist/`. For an app you run without installing, use `npm run build:unpack` and open `dist/win-unpacked/plexo.exe`.
-- **Linux**: `npm run build:linux` writes the AppImage and `.deb` packages to `dist/`
-
-Local builds are unsigned.
+Run platform packaging commands on the corresponding operating system. Local builds are unsigned unless signing credentials are configured. [CONTRIBUTING.md](CONTRIBUTING.md) covers packaging requirements, extension setup and testing.
## Contributing
-Contributions are welcome, from download engine work to testing Plexo on new network setups. Areas that need help:
-
-- Download and torrent throughput
-- Network adapter names on Linux
-- Testing with 5G tethering, Wi-Fi 6, and 10 GbE
-- The interface and documentation
-
-See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, code style, and how to open a pull request.
-
-## Built with
-
-Electron, React 19, TypeScript, Tailwind CSS v4, Base UI, Zustand, WebTorrent, and Lucide icons. electron-vite builds it, electron-builder packages it, and Playwright tests it.
-
-## Support Plexo
-
-If Plexo is useful to you:
-
-- Star the repository
-- [Report a bug or suggest a feature](https://github.com/anmolkapil/plexo/issues)
-- [Sponsor development](https://github.com/sponsors/anmolkapil)
+Start with [open issues](https://github.com/anmolkapil/plexo/issues), or contribute a reproducible bug report, a fix, network compatibility testing or documentation improvements.
-## Credits
+See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, required checks and pull request guidance. For a substantial feature, [open an issue](https://github.com/anmolkapil/plexo/issues/new) to discuss the approach before implementing it.
-Plexo is developed by [Anmol Kapil](https://github.com/anmolkapil).
+## Acknowledgements
-macOS code signing is provided by [Dhananjay Bhosale](https://github.com/DhananjayBhosale): the Mac app is signed with his Apple Developer ID, so macOS shows his name as its developer.
+Special thanks to [Dhananjay Bhosale](https://github.com/DhananjayBhosale) for code signing and notarizing the macOS app.
## License
-MIT. See [LICENSE](LICENSE).
+[MIT](LICENSE), copyright 2026 Anmol Kapil.
diff --git a/docs/index.html b/docs/index.html
index 78c4f4a..d36ad86 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -115,7 +115,7 @@
</div>
<a class="announce" href="#extension"
- ><span class="pill-new">New</span>Download with Plexo is now available on Chrome<span
+ ><span class="pill-new">New</span>Plexo extensions are live for Chrome and Firefox<span
class="announce-cta"
>Get the extension <span aria-hidden="true">→</span></span
></a
@@ -2323,9 +2323,15 @@
d="M8.824 7.287c.008 0 .004 0 0 0zm-2.8-1.4c.006 0 .003 0 0 0zm16.754 2.161c-.505-1.215-1.53-2.528-2.333-2.943.654 1.283 1.033 2.57 1.177 3.53l.002.02c-1.314-3.278-3.544-4.6-5.366-7.477-.091-.147-.184-.292-.273-.446a3.545 3.545 0 01-.13-.24 2.118 2.118 0 01-.172-.46.03.03 0 00-.027-.03.038.038 0 00-.021 0l-.006.001a.037.037 0 00-.01.005L15.624 0c-2.585 1.515-3.657 4.168-3.932 5.856a6.197 6.197 0 00-2.305.587.297.297 0 00-.147.37c.057.162.24.24.396.17a5.622 5.622 0 012.008-.523l.067-.005a5.847 5.847 0 011.957.222l.095.03a5.816 5.816 0 01.616.228c.08.036.16.073.238.112l.107.055a5.835 5.835 0 01.368.211 5.953 5.953 0 012.034 2.104c-.62-.437-1.733-.868-2.803-.681 4.183 2.09 3.06 9.292-2.737 9.02a5.164 5.164 0 01-1.513-.292 4.42 4.42 0 01-.538-.232c-1.42-.735-2.593-2.121-2.74-3.806 0 0 .537-2 3.845-2 .357 0 1.38-.998 1.398-1.287-.005-.095-2.029-.9-2.817-1.677-.422-.416-.622-.616-.8-.767a3.47 3.47 0 00-.301-.227 5.388 5.388 0 01-.032-2.842c-1.195.544-2.124 1.403-2.8 2.163h-.006c-.46-.584-.428-2.51-.402-2.913-.006-.025-.343.176-.389.206-.406.29-.787.616-1.136.974-.397.403-.76.839-1.085 1.303a9.816 9.816 0 00-1.562 3.52c-.003.013-.11.487-.19 1.073-.013.09-.026.181-.037.272a7.8 7.8 0 00-.069.667l-.002.034-.023.387-.001.06C.386 18.795 5.593 24 12.016 24c5.752 0 10.527-4.176 11.463-9.661.02-.149.035-.298.052-.448.232-1.994-.025-4.09-.753-5.844z"
/></svg
></span>
- <div class="ext-name"><strong>Firefox</strong></div>
- <!-- In review on AMO; link once listed: https://addons.mozilla.org/firefox/addon/download-with-plexo/ -->
- <span class="ext-soon">Coming soon</span>
+ <div class="ext-name">
+ <strong>Firefox</strong>
+ <span>Also Zen, Floorp &amp; other compatible Firefox-based browsers</span>
+ </div>
+ <a
+ class="btn-3d ext-btn ext-btn-primary"
+ href="https://addons.mozilla.org/en-US/firefox/addon/download-with-plexo/"
+ >Add to Firefox</a
+ >
</div>
</div>
</div>