Add basic readme.

tidal-music · Nov 4, 2024 · a44bd69 · a44bd69
1 parent b467d8d
commit a44bd69
Showing 1 changed file with 9 additions and 11 deletions.
diff --git a/tidalapi/README.md b/tidalapi/README.md
@@ -1,17 +1,15 @@
 # Module tidalapi
 
-This module provides easy access to the TIDAL Open API.
+This module provides easy access to the TIDAL Open API. Read more about it [here](https://developer.tidal.com/apiref?spec=catalogue-v2&ref=get-albums-v2&at=THIRD_PARTY).
 
----
 ## Prerequisites
 
-tbd
----
-## Installation
+To effectively use this module, you will need to be able to provide a `CredentialsProvider` instance
+from the `auth` module. This is necessary to authenticate with the TIDAL API.
 
-tbd
----
-<!-- USAGE EXAMPLES -->
-## Usage
-
-tbd
+Instantiate your `TidalApiClient` like this:
+```kotlin
+val client = TidalApiClient(credentialsProvider)
+```
+This client exposes the various API endpoints available as `Retrofit` service instances. You can
+then call the methods on these services to interact with the TIDAL API.