diff --git a/README.md b/README.md new file mode 100644 index 0000000..621b502 --- /dev/null +++ b/README.md @@ -0,0 +1,83 @@ +# ABS-Client + +> Ein nativer iOS- und macOS-Client für deine selbst gehostete [Audiobookshelf](https://www.audiobookshelf.org/)-Instanz. + +--- + +## 📖 Über die App + +**ABS-Client** ist eine native App für iPhone, iPad und Mac, die eine direkte Verbindung zu deiner eigenen Audiobookshelf-Serverinstanz herstellt. Du behältst die volle Kontrolle über deine Hörbuch-Bibliothek – ganz ohne Drittanbieter oder Cloud-Abhängigkeit. + +> ⚠️ **Hinweis:** Die App befindet sich noch in aktiver Entwicklung und ist aktuell noch nicht im App Store verfügbar. Der Release ist in Kürze geplant. + +--- + +## ✨ Features + +### Aktuell verfügbar +- 🔗 **Serververbindung** – Verbinde die App mit deiner eigenen Audiobookshelf-Instanz +- 📚 **Bibliotheks-Browser** – Durchsuche und verwalte deine Hörbücher +- ⬇️ **Download** – Lade Hörbücher für die Offline-Nutzung herunter +- 🎧 **Wiedergabe** – Höre deine Hörbücher direkt in der App + +### Geplant +- ⏱️ **Einschlaftimer** – Automatisches Stoppen der Wiedergabe nach einer festgelegten Zeit +- 🌍 **Mehrsprachigkeit** – Die App ist aktuell nur auf Deutsch verfügbar; weitere Sprachen sind in Planung + +--- + +## 📋 Voraussetzungen + +- **iOS / iPadOS:** 26.0 oder neuer +- **macOS:** 26.0 (Tahoe) oder neuer +- Eine laufende [Audiobookshelf](https://github.com/advplyr/audiobookshelf)-Serverinstanz + +--- + +## 🚀 Installation + +Die App ist noch nicht im App Store verfügbar. Wer die App bereits jetzt nutzen oder testen möchte, kann das Projekt selbst aus dem Quellcode bauen: + +```bash +git clone https://git.scarriffle.com/Scarriffle/ABS-Client.git +cd ABS-Client +``` + +Öffne das Projekt in Xcode, wähle dein Zielgerät und starte den Build. + +--- + +## 🔧 Einrichtung + +1. App starten +2. URL deiner Audiobookshelf-Instanz eingeben (z. B. `https://abs.deinserver.de`) +3. Mit deinen Zugangsdaten anmelden +4. Bibliothek auswählen und loslegen + +--- + +## 🤝 Beitragen + +Contributions sind willkommen! Wenn du einen Fehler gefunden hast oder eine Idee für ein neues Feature hast, eröffne gerne ein Issue oder einen Pull Request im Repository: + +👉 [git.scarriffle.com/Scarriffle/ABS-Client](https://git.scarriffle.com/Scarriffle/ABS-Client) + +Bitte achte auf einen sauberen, gut dokumentierten Code-Stil und beschreibe deine Änderungen im PR möglichst nachvollziehbar. + +--- + +## 📄 Lizenz + +Dieses Projekt ist Open Source. Details zur Lizenz findest du in der [LICENSE](LICENSE)-Datei. + +--- + +## 📬 Kontakt + +Bei Fragen, Feedback oder Problemen: + +✉️ [scarriffleservices@gmail.com](mailto:scarriffleservices@gmail.com) + +--- + +> ABS-Client ist ein unabhängiges Community-Projekt und steht in keiner Verbindung zum offiziellen [Audiobookshelf-Projekt](https://github.com/advplyr/audiobookshelf).