diff --git a/library/src/main/java/README.md b/library/src/main/java/README.md index 1dded58b..ec6b0df7 100644 --- a/library/src/main/java/README.md +++ b/library/src/main/java/README.md @@ -7,7 +7,7 @@ Kotlin code emitted by the `bindings_ffi` crate in [libxmtp](https://github.com/ 1. From repo [libxmtp](https://github.com/xmtp/libxmtp) run the [kotlin release action](https://github.com/xmtp/libxmtp/actions/workflows/release-kotlin-bindings.yml) for the branch you desire 2. Create a new branch in the `xmtp-android` repo With `libxmtp` repo and `xmtp-android` (this repo) cloned locally in sibling directories, and `libxmtp` checked out to the correct release commit, run the script: - `./bindings_ffi/gen_kotlin.sh` + `./gen_kotlin.sh` within the `bindings_ffi` folder. 3. Run format (cmd + opt + l) function to keep the code format consistent and diff small for `xmtp-android/library/src/main/java/xmtpv3.kt` 4. Navigate to the [latest release](https://github.com/xmtp/libxmtp/releases) once the action completes 5. Download the `LibXMTPKotlinFFI.zip` assets @@ -15,4 +15,4 @@ Kotlin code emitted by the `bindings_ffi` crate in [libxmtp](https://github.com/ 7. All instances of `value.forEach` should be changed to `value.iterator().forEach` to be compatible with API 23 8. NOTE: sometimes the library name gets updated and will cause failures the library name must be `uniffi_xmtpv3` not `xmtpv3` -- search for `findLibraryName` and make sure the correct name is returned. -You should now be on the latest libxmtp. Tests will fail if the jniLibs do not match the version of xmtpv3. \ No newline at end of file +You should now be on the latest libxmtp. Tests will fail if the jniLibs do not match the version of xmtpv3.