Prettified the README
This commit is contained in:
20
README.md
20
README.md
@@ -1,24 +1,24 @@
|
||||
Maloja-Lidarr Importer
|
||||
Overview
|
||||
🎯 Overview
|
||||
This project provides a simple API service that syncs your listening history from a self-hosted Maloja instance to a Lidarr custom import list.
|
||||
|
||||
Lidarr's custom import feature requires a JSON list of MusicBrainz Artist IDs. This service automatically fetches your unique artists from Maloja and serves them in the correct format, allowing Lidarr to add new artists to your library.
|
||||
Lidarr's custom import feature requires a JSON list of MusicBrainz Artist IDs. This service automatically fetches your unique artists from Maloja and serves them in the correct format, allowing Lidarr to add new artists to your library automatically.
|
||||
|
||||
Features
|
||||
✨ Features
|
||||
Automatic Synchronization: Fetches and updates the list of artists from your Maloja instance every hour.
|
||||
|
||||
MusicBrainz Integration: Resolves artist IDs even when a MusicBrainz ID for a track isn't available.
|
||||
|
||||
Docker-Ready: Packaged as a lightweight Docker image for easy deployment.
|
||||
|
||||
Prerequisites
|
||||
📦 Prerequisites
|
||||
Docker and Docker Compose
|
||||
|
||||
A Maloja instance with API access enabled
|
||||
|
||||
A Lidarr instance
|
||||
|
||||
Getting Started
|
||||
🚀 Getting Started
|
||||
1. Clone the Repository
|
||||
Bash
|
||||
|
||||
@@ -44,10 +44,10 @@ To start the service, simply run the following command in the project's root dir
|
||||
Bash
|
||||
|
||||
docker-compose up -d
|
||||
This command will build the Docker image (if you're using the build directive) and start the container in the background.
|
||||
This command will pull the pre-built Docker image and start the container in the background.
|
||||
|
||||
Lidarr Setup
|
||||
In Lidarr, go to Settings -> Import Lists.
|
||||
🎶 Lidarr Setup
|
||||
In Lidarr, navigate to Settings -> Import Lists.
|
||||
|
||||
Click the + button to add a new list.
|
||||
|
||||
@@ -67,5 +67,5 @@ Password: (Leave blank)
|
||||
|
||||
This URL uses Docker's internal networking to allow Lidarr to communicate directly with the API container, bypassing any external authentication proxies or firewalls.
|
||||
|
||||
License
|
||||
This project is licensed under the MIT License. See the LICENSE file for details.
|
||||
📄 License
|
||||
This project is licensed under the MIT License.
|
Reference in New Issue
Block a user