diff --git a/preamble.md b/preamble.md index 31db1b3ac0de23c2e4ce24f4e77e6ece7a256958..d9e9f1dcaffd53d8c02b06c2969dcd421b7bc63d 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/