Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add basic readme for TidalApi module #135

Merged
merged 1 commit into from
Nov 4, 2024
Merged

Add basic readme for TidalApi module #135

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions tidalapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Loading