diff --git a/README.md b/README.md index 00680d8d..01e81112 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,10 @@ Moved details to [CHANGELOG.md](https://github.com/eddyizm/tempo/blob/main/CHANG Fork [**sponsorship here**](https://ko-fi.com/eddyizm). +## Usage + +[Documentation](USAGE.md) (work in progress) + ## Features - **Subsonic Integration**: Tempo seamlessly integrates with your Subsonic server, providing you with easy access to your entire music collection on the go. - **Sleek and Intuitive UI**: Enjoy a clean and user-friendly interface designed to enhance your music listening experience, tailored to your preferences and listening history. diff --git a/USAGE.md b/USAGE.md new file mode 100644 index 00000000..31fbd060 --- /dev/null +++ b/USAGE.md @@ -0,0 +1,146 @@ +# App Name Usage Guide +[<- back home](README.md) + +## Table of Contents +- [Prerequisites](#prerequisites) +- [Getting Started](#getting-started) +- [Server Configuration](#server-configuration) +- [Main Features](#main-features) +- [Navigation](#navigation) +- [Playback Controls](#playback-controls) +- [Favorites](#favorites) +- [Playlist Management](#playlist-management) +- [Android Auto](#android-auto) +- [Settings](#settings) +- [Troubleshooting](#troubleshooting) + +## Prerequisites + +**Important Notice**: This app is a Subsonic-compatible client and does not provide any music content itself. To use this application, you must have: + +- An active Subsonic API server (or compatible service) already set up +- Valid login credentials for your Subsonic server +- Music content uploaded and organized on your server + +### Verified backends +This app works with any service that implements the Subsonic API, including: +- [LMS - Lightweight Music Server](https://github.com/epoupon/lms) - *personal fave and my backend* +- [Navidrome](https://www.navidrome.org/) +- [Gonic](https://github.com/sentriz/gonic) + + + + +## Getting Started + +### Installation +1. Download the APK from the [Releases](https://github.com/eddyizm/tempo/releases) section +2. Enable "Install from unknown sources" in your Android settings +3. Install the application + +### First Launch +1. Open the application +2. You will be prompted to configure your server connection +3. Grant necessary permissions for media playback and background operation + +## Server Configuration + +### Initial Setup +**IN PROGRESS** +1. Enter your server URL (e.g., `https://your-subsonic-server.com`) +2. Provide your username and password +3. Test the connection to ensure proper configuration + +### Advanced Settings +**TODO** + +## Main Features + +### Library View +**TODO** + +### Now Playing Screen +**TODO** + +## Navigation + +### Bottom Navigation Bar +**IN PROGRESS** +- **Home**: Recently played and server recommendations +- **Library**: Your server's complete music collection +- **Download**: Locally downloaded files from server + +## Playback Controls + +### Streaming Controls +**TODO** + +### Advanced Controls +**TODO** + +## Favorites + +### Favorites (aka heart aka star) to albums and artists +- Long pressing on an album gives you access to heart/unheart an album + +
+
+
+
+