diff --git a/README.md b/README.md index a51f844..6aad29e 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,14 @@ -# ios-ble-wrapper-solana -The wrapper to use the Solana app binding with the iOS BLE Transport extension +# SolanaWrapper + +This is the Swift Package to use the JavaScript Solana app binding in a native way. It consist of a `bundle.js` which is the compiled app binding (plus a wrapper) and convenience methods. + +Whenever there's a change in the Solana app binding or the wrapper, `bundle.js` has to be regenerated using [browserify](https://browserify.org/). + +### How to generate `bundle.js` + +1. Clone the [monorepo](https://github.com/ledgerhq/ledger-live) and compile the libraries using `pnpm build:libs` +2. Use [browserify](https://browserify.org/) to wrap everything needed for `JavaScriptCore` to run the binding and put it into the `JavaScript` folder inside the Package (should replace the current `bundle.js`) using the following command: + +``` +browserify /ledger-live/libs/ledgerjs/iOS-wrappers/ios-wrapper-solana/lib/Wrapper.js -o "/ios-ble-wrapper-solana/Sources/SolanaWrapper/JavaScript/bundle.js" -d -s TransportModule +```