Merge pull request #8 from bryantkelley/feat/update-README-links

Update README to link to new meshcore-dev/MeshCore repo
This commit is contained in:
Liam Cottle 2026-01-02 23:37:35 +13:00 committed by GitHub
commit 3a9fd3dab2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -1,6 +1,6 @@
# MeshCore.js
A Javascript library for interacting with a [MeshCore](https://github.com/ripplebiz/MeshCore) device running the [Companion Radio Firmware](https://github.com/ripplebiz/MeshCore/blob/main/examples/companion_radio/main.cpp).
A Javascript library for interacting with a [MeshCore](https://github.com/meshcore-dev/MeshCore) device running the [Companion Radio Firmware](https://github.com/meshcore-dev/MeshCore/blob/main/examples/companion_radio/main.cpp).
This library can be used in a Web Browser to connect to MeshCore Companion devices over BLE or USB Serial.
@ -9,11 +9,11 @@ It can also be used in NodeJS to connect to MeshCore Companion devices over TCP/
## Supported Connection Methods
- Web Browser
- BLE: [WebBleConnection()](./src/connection/web_ble_connection.js)
- USB/Serial: [WebSerialConnection()](./src/connection/web_serial_connection.js)
- BLE: [WebBleConnection()](./src/connection/web_ble_connection.js)
- USB/Serial: [WebSerialConnection()](./src/connection/web_serial_connection.js)
- NodeJS
- TCP/WiFi: [TCPConnection("host", "port")](./src/connection/tcp_connection.js)
- USB/Serial: [NodeJSSerialConnection("/dev/ttyUSB0")](./src/connection/nodejs_serial_connection.js)
- TCP/WiFi: [TCPConnection("host", "port")](./src/connection/tcp_connection.js)
- USB/Serial: [NodeJSSerialConnection("/dev/ttyUSB0")](./src/connection/nodejs_serial_connection.js)
## Install