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

Update README documentation #349

Merged
merged 1 commit into from
Dec 6, 2022
Merged

Update README documentation #349

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
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ yarn add @jellyfin/sdk

| SDK Version | Jellyfin Version |
|:-:|:-:|
| 0.7.0 | 10.8.1+ |
| 0.6.0 | 10.8.1 |
| 0.8.0 | 10.8.1 - 10.8.8 |
| 0.7.0 | 10.8.1 - 10.8.8 |
| 0.6.0 | 10.8.1 - 10.8.8 |
| 0.5.0 | 10.8.0 |
| <0.5.0 | 10.7.x |

Expand Down Expand Up @@ -73,9 +74,13 @@ const best = jellyfin.discovery.findBestServer(servers);
// Create an API instance
const api = jellyfin.createApi(best.address);

// Each API endpoint is exposed via a getter on the SDK instance using
// a shared Configuration and Axios instance. For example the /System APIs
// are available as api.systemApi.
// Each API endpoint is represented by a class in the generated client.
// Helper utility functions are provided under `/lib/utils/api/` to create an
// instance of a specific Jellyfin API using the shared Configuration and Axios
// instance from the `api` object created above.

// For example, the SystemApi can be generated using the `getSystemApi`
// function in `/lib/utils/api/system-api`.

// Fetch the public system info
const info = await getSystemApi(api).getPublicSystemInfo();
Expand Down