@xstoicunicornx/payjoin_test 0.1.7 → 0.1.8

package/README.md

@@ -2,7 +2,37 @@
 
 Welcome to the JavaScript language bindings for the [Payjoin Dev Kit](https://payjoindevkit.org/)!
 
-## Running Tests
+## Usage
+
+### Install
+
+```shell
+npm install payjoin
+```
+
+### Import
+
+For node environments:
+
+```js
+import { uniffiInitAsync, payjoin } from "payjoin";
+
+// initialize before usage
+await uniffiInitAsync();
+```
+
+For web browser environments:
+
+```js
+import * as payjoin from "payjoin/web";
+// or for usage with Vite
+import * as payjoin from "payjoin/web-vite";
+
+// initialize before usage
+await payjoin.uniffiInitAsync();
+```
+
+## Build Bindings
 
 Follow these steps to clone the repository and run the tests.
 This assumes you already have Rust and Node.js installed.
@@ -14,15 +44,24 @@ cd rust-payjoin/payjoin-ffi/javascript
 # Clean out stale dependencies
 npm run clean
 rm -rf node_modules
+
 # Install dependencies
 cargo install wasm-bindgen-cli
-npm install
 # (macOS only - secp256k1-sys requires a WASM-capable C compiler)
 brew install llvm
+npm install
 
 # Generate the bindings
 bash ./scripts/generate_bindings.sh
 
+```
+
+## Running Tests
+
+```shell
 # Run all tests
 npm test
+
 ```
+
+Made with [uniffi-bindgen-react-native](https://github.com/jhugman/uniffi-bindgen-react-native)