Skip to content

Update README to link to new meshcore-dev/MeshCore repo #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bryantkelley wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README to link to new meshcore-dev/MeshCore repo #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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

Expand Down