chore: rework plugin readmes, json changelogs and standalone repo setup

This commit is contained in:
LukeGus committed 2026-10-04 21:25:16 -05:00
1 parent a8f383d2b3
commit 29a946d02e
500 files changed
+6729 -1250

No files matched your search

+29 -13
View File
@@ -1,21 +1,37 @@
# Serial
<div align="center">
Open a serial console to a device plugged into your computer.
<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
<h1>Serial</h1>
<p>Talk to serial devices from Termix</p>
</div>
<br />
## Overview
Serial opens a console to a device plugged into your computer, like a router, switch or microcontroller.
<br />
## Features
- Open a serial console to a device plugged into your computer.
- The desktop app talks to the device directly.
- In a browser, the plugin uses Web Serial.
- Set the baud rate, data bits, stop bits and parity
- The desktop app talks to the device directly
- Browsers use the Web Serial API (Chrome, Edge or Firefox 151 and newer)
## Setup
<br />
The desktop app uses the `serialport` npm package, which has a native binary. The build does not bundle it.
## Support
## Development
To report a bug or request a feature, open a [support ticket](https://github.com/Termix-SSH/Support/issues/new/choose). You need to be logged in to GitHub. Please be as detailed as possible, preferably in English.
```bash
npm run build # build into dist/
npm run test # run this plugin's tests
npm run typecheck # type-check this plugin
```
For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server.
<br />
## License
Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE) for more information.