From d7c8ec8dc5965fdcc1f94dbb36a42f4ff8564207 Mon Sep 17 00:00:00 2001 From: Janis Hutz Date: Sat, 29 Aug 2026 16:16:16 +0200 Subject: [PATCH] chore: update readme --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2b55d7d..741c257 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,24 @@ # musickitjs-v3-types TypeScript Type Declarations for [MusicKit JS V3](https://js-cdn.music.apple.com/musickit/v3/docs/index.html?path=/story/introduction--page) -## Docs only -The below URL could be used in the future to auto-generate these types +## Usage +Install using +```bash +npm install --save-dev musickitjs-v3-types +``` +Then, add +```js +import 'musickitjs-v3-types'; +``` +to every file where you need the global `MusicKit`. +You can further use +```js +import MusicKitInstance from 'musickitjs-v3-types/MusicKitInstance'; +``` +to get access to the `MusicKitInstance` definitions only. + +