Skip to content

Commit

Permalink
Add Linux to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kuba2k2 committed Apr 5, 2024
1 parent 9b8d9d5 commit 9e90ad1
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,38 @@ This add-on allows to use the WebSerial API in Firefox.

It uses a native application to communicate with serial ports.

**NOTE:** Currently, the add-on only works on Windows.
**NOTE:** Currently, the add-on only works on Windows and Linux (x86-64).

## Installation

The add-on is available for download from Mozilla Addons:
[WebSerial for Firefox](https://addons.mozilla.org/pl/firefox/addon/webserial-for-firefox/).

The native application needs to be installed on the computer first. The GUI will offer to download and install the
The native application needs to be installed on the computer first. The GUI will offer to download the
native application when you first try to open a serial port.

### Installation on Windows

The .exe file is an installer - just open it and install the native application.

### Installation on Linux

Put the downloaded file in `~/.mozilla/native-messaging-hosts`, rename it to just `firefox-webserial`.

Create a file named `io.github.kuba2k2.webserial.json` in the same directory, with this content:

```json
{
"name": "io.github.kuba2k2.webserial",
"description": "WebSerial for Firefox",
"path": "/home/USER/.mozilla/native-messaging-hosts/firefox-webserial",
"type": "stdio",
"allowed_extensions": ["[email protected]"]
}
```

Adjust `/home/USER` to match your username.

## Usage

Some applications that can work on Firefox with this add-on:
Expand Down

0 comments on commit 9e90ad1

Please sign in to comment.