diff --git a/README.md b/README.md index e6221732..765ce8c9 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ This is the repository for TIDAL Android SDK modules. ### First time setup It is strongly recommended to run `local-setup.sh` right after cloning the repository. This will install the pre-commit git hook to run lint checks for your code. CI will also run these checks, but it's best to prevent CI failures by running the checks locally. +To run a specific module's test app, you might have to create a `local.properties` file in the root of the project, and add values according to that app's requirements. +`` ### Creating a new module 1. Run the `generate-module.sh` script. It will prompt you to enter a module name using [PascalCase](https://pl.wikipedia.org/wiki/PascalCase). After confirming the name, a new directory will be created with the basic module setup. diff --git a/auth/apps/demo/src/main/kotlin/com/tidal/sdk/demo/MainActivity.kt b/auth/apps/demo/src/main/kotlin/com/tidal/sdk/demo/MainActivity.kt index f10b7cb9..20f74d9a 100644 --- a/auth/apps/demo/src/main/kotlin/com/tidal/sdk/demo/MainActivity.kt +++ b/auth/apps/demo/src/main/kotlin/com/tidal/sdk/demo/MainActivity.kt @@ -48,8 +48,14 @@ class MainActivity : ComponentActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) + /** + * This test app expects the following values in 'local.properties' to be set: + * TIDAL_CLIENT_ID: The id of the app created by you in the TIDAL developer portal + * TIDAL_CLIENT_SECRET: The secret generated for this id + * TIDAL_CLIENT_SCOPES: The scopes you selected in the portal, entered as a single + * string, scopes separated by a space + */ val authConfig = AuthConfig( - // Make sure to provide your clientId and required credentials in local.properties clientId = BuildConfig.TIDAL_CLIENT_ID, clientSecret = BuildConfig.TIDAL_CLIENT_SECRET, scopes = BuildConfig.TIDAL_CLIENT_SCOPES.split(" ").toSet(),