From aa8a1782dcdbc638d8fe31be551ab409b2d75896 Mon Sep 17 00:00:00 2001 From: Brandon Estrella Date: Thu, 5 Nov 2026 12:01:09 -0800 Subject: [PATCH] docs: shorten the README's mobile setup and link to the guides Keep the environment variables Core needs and the SDK table. The app-side steps for iOS Universal Links and Android App Links are on the docs site. --- README.md | 111 +++++------------------------------------------------- 1 file changed, 10 insertions(+), 101 deletions(-) diff --git a/README.md b/README.md index 0ba06f8..1790f1a 100644 --- a/README.md +++ b/README.md @@ -146,93 +146,16 @@ Core runs anywhere you can run a container with PostgreSQL 13+ (Redis is optiona ## Mobile SDK Integration -LinkForty Core supports iOS Universal Links and Android App Links for seamless deep linking in mobile applications. - -### iOS Universal Links Setup - -1. **Set environment variables:** - ```bash - IOS_TEAM_ID=ABC123XYZ # Your Apple Developer Team ID - IOS_BUNDLE_ID=com.yourcompany.yourapp - ``` - -2. **Configure in Xcode:** - - Add "Associated Domains" capability - - Add domain: `applinks:yourdomain.com` - -3. **Verify AASA file:** - ```bash - curl https://yourdomain.com/.well-known/apple-app-site-association - ``` - - Expected response: - ```json - { - "applinks": { - "apps": [], - "details": [ - { - "appID": "ABC123XYZ.com.yourcompany.yourapp", - "paths": ["*"] - } - ] - } - } - ``` - -### Android App Links Setup - -1. **Get your SHA-256 fingerprint:** - ```bash - # Debug keystore - keytool -list -v -keystore ~/.android/debug.keystore \ - -alias androiddebugkey -storepass android -keypass android - - # Release keystore - keytool -list -v -keystore /path/to/release.keystore \ - -alias your-alias - ``` - -2. **Set environment variables:** - ```bash - ANDROID_PACKAGE_NAME=com.yourcompany.yourapp - ANDROID_SHA256_FINGERPRINTS=AA:BB:CC:DD:... - - # Multiple fingerprints (debug + release) - ANDROID_SHA256_FINGERPRINTS=AA:BB:CC:...,DD:EE:FF:... - ``` - -3. **Configure in AndroidManifest.xml:** - ```xml - - - - - - - - ``` - -4. **Verify assetlinks.json:** - ```bash - curl https://yourdomain.com/.well-known/assetlinks.json - ``` - - Expected response: - ```json - [ - { - "relation": ["delegate_permission/common.handle_all_urls"], - "target": { - "namespace": "android_app", - "package_name": "com.yourcompany.yourapp", - "sha256_cert_fingerprints": ["AA:BB:CC:..."] - } - } - ] - ``` - -### Available Mobile SDKs +Core serves the verification files for iOS Universal Links and Android App Links. Set these environment variables and it generates them at `/.well-known/apple-app-site-association` and `/.well-known/assetlinks.json`: + +```bash +IOS_TEAM_ID=ABC123XYZ +IOS_BUNDLE_ID=com.yourcompany.yourapp +ANDROID_PACKAGE_NAME=com.yourcompany.yourapp +ANDROID_SHA256_FINGERPRINTS=AA:BB:CC:DD:... # comma-separated for more than one +``` + +See [iOS Universal Links](https://docs.linkforty.com/guides/attribution/sdk-integration#ios-universal-links) and [Android App Links](https://docs.linkforty.com/guides/attribution/sdk-integration#android-app-links) for the app-side setup. | Platform | Package | Install | |----------|---------|---------| @@ -244,20 +167,6 @@ LinkForty Core supports iOS Universal Links and Android App Links for seamless d See the [SDK documentation](https://docs.linkforty.com/sdks/react-native) for integration guides. -### Testing Domain Verification - -Test iOS Universal Links with Apple's validator: -```bash -https://search.developer.apple.com/appsearch-validation-tool/ -``` - -Test Android App Links with Google's validator: -```bash -adb shell am start -a android.intent.action.VIEW \ - -d "https://yourdomain.com/test" -``` - - ## For AI Tools (llms.txt) LinkForty provides machine-readable documentation for AI coding assistants (Claude, ChatGPT, Cursor, Copilot).