@smithii_io/mixoor 0.0.1

package/README.md

@@ -0,0 +1,38 @@
+# JavaScript client
+
+A generated JavaScript library for the Mixoor program.
+
+## Getting started
+
+To build and test your JavaScript client from the root of the repository, you may use the following command.
+
+```sh
+pnpm clients:js:test
+```
+
+This will start a new local validator, if one is not already running, and run the tests for your JavaScript client.
+
+## Available client scripts.
+
+Alternatively, you can go into the client directory and run the tests directly.
+
+```sh
+# Build your programs and start the validator.
+pnpm programs:build
+pnpm validator:restart
+
+# Go into the client directory and run the tests.
+cd clients/js
+pnpm install
+pnpm build
+pnpm test
+```
+
+You may also use the following scripts to lint and/or format your JavaScript client.
+
+```sh
+pnpm lint
+pnpm lint:fix
+pnpm format
+pnpm format:fix
+```