BranchMetrics / capacitor-branch-deep-links

Capacitor plugin for branch.io deep links
MIT License
32 stars 44 forks source link

Please update documentation #89

Open Maartenb111 opened 1 year ago

Maartenb111 commented 1 year ago

Describe the bug

Please update documentation at https://help.branch.io/developers-hub/docs/capacitor (and keep version history of it). For example, Android Branch SDK dependency type changed from implementation to api.

P.s. tried to report this as a documentation issue but the button 'Suggest edits' is not on the documentation page :-/

Steps to reproduce

None

Expected behavior

None

SDK Version

5

Make and Model

None

OS

None

Additional Information/Context

No response

Sampath-Lokuge commented 1 year ago

Did they update the docs now?

Saqib92 commented 1 year ago

any update?

GiannisS commented 11 months ago

Documentation suggests that it got "Updated 5 days ago" but it's definitely incomplete. For example here https://help.branch.io/developers-hub/docs/capacitor#android it suggests that we should update build.gradle with these dependencies

apply plugin: 'com.android.application'

android {
    defaultConfig {
        // ...
+       multiDexEnabled true
        // ...
    }
}

dependencies {
+    implementation("com.google.android.gms:play-services-ads-identifier:18.0.1") // AAID
}

but if you try to build your app in android studio with just these dependencies you are getting errors. The correct documentation should also mention we have to add all these

    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'androidx.multidex:multidex:2.0.1'
    implementation 'com.google.firebase:firebase-appindexing:19.1.0'
    implementation 'androidx.browser:browser:1.2.0'
    implementation 'io.branch.sdk.android:library:5.0.15'
viking2917 commented 6 days ago

@GiannisS Thank you for this! In my case, I am on Capacitor 6, and I only had to add:

    implementation 'com.google.android.gms:play-services-ads-identifier:18.0.1'
    implementation 'androidx.multidex:multidex:2.0.1'

do you know whether the firebase-appindexing, browser, and sdk.android:library are still required?

viking2917 commented 6 days ago

also, I did a 'Suggest Edits' on the Branch documentation page, maybe they will take it :)