📝 Package: Add README

Author: superturboryan

README.md

@@ -0,0 +1,123 @@
+![Group 1](https://github.com/user-attachments/assets/1cefe10d-0b3c-45be-a7e9-443603704ca7)
+![Build Status](https://github.com/superturboryan/ControlKit/workflows/%F0%9F%A7%A9%20Build%20Package/badge.svg) ![Lint](https://github.com/superturboryan/ControlKit/workflows/%F0%9F%A7%B9%20Lint/badge.svg) ![Contributors](https://img.shields.io/github/contributors/superturboryan/ci-playground)
+
+**ControlKit** is a lightweight Swift Package enabling control of media playback and system volume for third-party 
+apps.
+
+## Installation
+
+To install **ControlKit**, add it as a dependency to your Xcode project by going to   
+
+```
+File > Add Package Dependencies...
+```  
+
+Enter the package URL  
+
+```
+https://github.com/superturboryan/ControlKit.git
+```  
+
+in the search bar:    
+  
+![Screenshot 2024-10-28 at 17 54 24](https://github.com/user-attachments/assets/4261f2ee-bbde-49c1-a911-f2a3217db586)
+
+This package contrains two libraries: **Control** + **Controllers**.  
+
+Select the libraries you want to add to your project's targets:    
+      
+![Screenshot 2024-10-28 at 17 46 50](https://github.com/user-attachments/assets/48e0a678-fd75-4056-9754-867a11b87d67)
+
+## Requirements
+
+[`SpotifyController`](Sources/Controllers/SpotifyController.swift) requires a **Spotify Client ID 
+and Redirect URL** in order to authorize & connect with to the Spotify app.
+You'll need to _create an app_ in the [Spotify Developer Dashboard](https://developer.spotify.com/dashboard) 
+in order to get a _client ID_ and register your _redirect URL_.  
+
+You'll also need to [define a custom URL scheme (_redirect URL_) for your app](https://developer.apple.com/documentation/xcode/defining-a-custom-url-scheme-for-your-app) 
+so that Spotify is able to reopen your app after completing the authorization flow.  
+
+Add a `URL Type` to the target's `Info.plist`:  
+
+<img width="1007" alt="Screenshot 2024-10-29 at 17 31 24" src="https://github.com/user-attachments/assets/895c8092-4a9d-4526-9f85-5da7b868fbc1">
+
+### Warning 🦺
+
+**The `Spotify` access token is not persisted across app launch** by default. You must provide an object conforming
+to `DAO<String>` if you want the access to be persisted.
+
+## Usage
+
+### Control
+
+```swift
+import Control
+
+// 🔊 Increment system volume
+Control.Volume.increaseVolume()
+
+// 🕵️‍♂️ Check if audio is being played (by another app)
+if Control.Playback.isAudioPlaying { 
+    // 💃🕺 
+}
+
+// ⏭️ Skip to next track (Apple Music only - use Controllers.SpotifyController for Spotify 💚)
+Control.Playback.AppleMusic.skipToNextTrack()
+
+// 🫨 Vibrate
+Control.Haptics.vibrate()
+```
+
+### Controllers
+
+```swift
+// App.swift
+
+import Controllers
+import SwiftUI
+
+@main struct YourApp: App {
+
+    @StateObject var spotify = SpotifyController(
+        config: .init(
+            clientID: SpotifyConfig.clientID,
+            redirectURL: SpotifyConfig.redirectURL
+        )
+    )
+    
+    var body: some Scene {
+        WindowGroup {
+            ContentView()
+            .environmentObject(spotify)
+            .onOpenURL { spotify.setAccessToken(from: $0) } // Parse access token from URL
+        }
+    }
+    
+    func skipToNextSpotifyTrack() {
+        spotify.skipToNextTrack()
+    }
+}
+
+// Secrets.swift 🔐
+// Don't forget to gitignore this 🙈
+
+enum SpotifyConfig {
+    static let clientID = "<your client id>"
+    static let redirectURL = "controlkit://spotify"
+}
+```
+
+## Dependencies
+
+📚 [AVFAudio](https://developer.apple.com/documentation/avfaudio)  
+📚 [Media Player](https://developer.apple.com/documentation/mediaplayer/)    
+📦 [SpotifyiOS](https://github.com/spotify/ios-sdk)  
+
+## Contributing
+
+Contributions and feedback are welcome! 🤝  
+
+You can open an Issue or raise a PR.
+
+Emojis required in all commit messages ❤️