Skip to content
Snippets Groups Projects
Commit 15a17187 authored by echicken's avatar echicken :chicken:
Browse files

dox

parent a9753bb8
No related branches found
No related tags found
No related merge requests found
Pipeline #6340 canceled
......@@ -2,7 +2,13 @@
A library for communicating with socket & serial [Meshtastic](https://meshtastic.org/) devices from [Synchronet JavaScript](https://synchro.net/docs/jsobjs.html) modules.
## Example
You can use this **Meshtastic** package in a TS4S project, or the JS build directly in a Synchronet JavaScript project. ([TS4S](https://gitlab.synchro.net/swag/ts4s) is a TypeScript build system that produces Synchronet-compatible JavaScript.)
To do: include link to build after CI stuff is set up
To do: TS4S is only available to internal users and a deploy token is required, so the example doesn't work. Make all of SWAG public and remove deploy tokens from various package.json files.
## TypeScript Example
```sh
npm config set @buf:registry https://buf.build/gen/npm/v1/
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment