From 15a17187ddfb40abfa383985967f53f5569e4e45 Mon Sep 17 00:00:00 2001 From: echicken <echicken@bbs.electronicchicken.com> Date: Sun, 21 Apr 2024 02:53:34 +0000 Subject: [PATCH] dox --- preamble.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/preamble.md b/preamble.md index 31db1b3..d9e9f1d 100644 --- a/preamble.md +++ b/preamble.md @@ -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/ -- GitLab