Skip to content

Refresh README to match current API surface and NDK asset model#5

Merged
fulvius31 merged 3 commits into
mainfrom
copilot/update-readme
Mar 31, 2026
Merged

Refresh README to match current API surface and NDK asset model#5
fulvius31 merged 3 commits into
mainfrom
copilot/update-readme

Conversation

Copilot AI commented Mar 31, 2026

Copy link
Copy Markdown
Contributor

The README was out of sync with the current library behavior and integration surface. This update aligns public documentation with the actual constructor/API signatures, callback/model fields, and post-NDK asset requirements.

  • API usage/docs alignment

    • Updated all WpsConnectionManager examples/signatures to the current constructor:
      • WpsConnectionManager(Context context)
    • Removed obsolete WpsLibConfig usage from README examples.
  • Callback + model documentation updates

    • Documented the Pixie Dust callback overload that includes exchange logs:
      • onPixieDustSuccess(String pin, String password, String wpsExchangeLog)
    • Added wpsExchangeLog to NetworkToTest docs and clarified null behavior/propagation to callback parameter.
  • Platform/ABI documentation

    • Added explicit supported ABIs: armeabi-v7a, arm64-v8a, x86_64.
    • Clarified that x86 (32-bit Intel) is not included.
  • Required assets section (NDK migration)

    • Replaced outdated binary/library asset list with current requirement:
      • only pin.db must be provided in app assets.
    • Clarified that executables/shared libraries are bundled as native libs.
// Before (outdated in README)
WpsLibConfig config = new WpsLibConfig(context.getDataDir().getAbsolutePath());
WpsConnectionManager manager = new WpsConnectionManager(context, config);

// After (current API)
WpsConnectionManager manager = new WpsConnectionManager(context);

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • dl.google.com
    • Triggering command: /usr/lib/jvm/temurin-17-jdk-amd64/bin/java /usr/lib/jvm/temurin-17-jdk-amd64/bin/java --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.invoke=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.prefs/java.util.prefs=ALL-UNNAMED --add-opens=java.base/java.nio.charset=ALL-UNNAMED --add-opens=java.base/java.net=ALL-UNNAMED --add-opens=java.base/java.util.concurrent=ALL-UNNAMED --add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED --add-opens=java.xml/javax.xml.namespace=ALL-UNNAMED --add-opens=java.base/java.time=ALL-UNNAMED -Xmx2048m -Dfile.encoding=UTF-8 -Duser.country -Duser.language=en -Duser.variant (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI changed the title [WIP] Update README file with additional information Refresh README to match current API surface and NDK asset model Mar 31, 2026
Copilot AI requested a review from fulvius31 March 31, 2026 02:30
@fulvius31 fulvius31 marked this pull request as ready for review March 31, 2026 02:34
@fulvius31 fulvius31 merged commit e02507d into main Mar 31, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants