From 8e01c4ba93426959fb1a69f54dfd740ceaa3f8b9 Mon Sep 17 00:00:00 2001 From: Stephen Gutekanst Date: Wed, 5 Apr 2023 03:08:35 -0700 Subject: [PATCH] sysjs: add README Signed-off-by: Stephen Gutekanst --- libs/sysjs/README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/libs/sysjs/README.md b/libs/sysjs/README.md index aa8389b4..5f32568e 100644 --- a/libs/sysjs/README.md +++ b/libs/sysjs/README.md @@ -1 +1,23 @@ -# mach-sysjs +# mach/sysjs - enables Zig/WASM to speak to JavaScript + +This repository is a separate copy of the same library in the [main Mach repository](https://github.com/hexops/mach), and is automatically kept in sync, so that anyone can use this library in their own project if they like! + +## Experimental + +This is an _experimental_ Mach library, according to our [stability guarantees](https://machengine.org/next/docs/libs/): + +> Experimental libraries may have their APIs change without much notice, and you may have to look at recent changes in order to update your code. + +[Why this library is not declared stable yet](https://machengine.org/next/docs/libs/experimental/#sysjs) + +## Join the community + +Join the Mach community [on Discord](https://discord.gg/XNG3NZgCqp) to discuss this project, ask questions, get help, etc. + +## Issues + +Issues are tracked in the [main Mach repository](https://github.com/hexops/mach/issues?q=is%3Aissue+is%3Aopen+label%3Asysjs). + +## Contributing + +Contributions are very welcome. Pull requests must be sent to [the main repository](https://github.com/hexops/mach/tree/main/libs/sysjs) to avoid some complex merge conflicts we'd get by accepting contributions in both repositories. Once the changes are merged there, they'll get sync'd to this repository automatically.