@xmtp/wasm-bindings 0.0.1 → 0.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,21 +1,10 @@
1
- # [WASM](https://webassembly.org/) for the libXMTP rust library
1
+ # WASM bindings for the libXMTP rust library
2
2
 
3
- # WARNING: DO NOT USE FOR PRODUCTION XMTP CLIENTS
3
+ > [!CAUTION]
4
+ > These bindings are currently in alpha and under heavy development. The API is subject to change and it is not yet recommended for production use.
4
5
 
5
- This code is still under development.
6
+ ## Useful commands
6
7
 
7
- ## Generate bindings for Node.js
8
-
9
- ```shell
10
- cd bindings_wasm
11
- npm i
12
- npm run build
13
- ```
14
-
15
- ## Test the WASM bindings from Node.js
16
-
17
- Use the steps above to generate the bindings first.
18
-
19
- ```shell
20
- node test.mjs
21
- ```
8
+ - `yarn`: Installs all dependencies (required before building)
9
+ - `yarn build`: Build a release version of the WASM bindings for the current platform
10
+ - `yarn lint`: Run cargo clippy and fmt checks