From bf60add2f5a2de23a051e019561486e74dd6ecbd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?M=C3=A1rcio=20Fernandes?=
 <marcio.fernandes@limbosolutions.com>
Date: Wed, 28 Aug 2024 23:23:45 +0100
Subject: [PATCH] readme.md

---
 README.md | 61 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 57 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index 01dc93f..1ec35c4 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,60 @@
-# lms
+# Lyrion Music Server (LMS)
 
-## Hosting
+Welcome to my Lyrion Music Server (LMS) setup repo.
 
-Hosted on [homesrv01.dev.lan](/marcio.fernandes/homesrv01.dev.lan).
+Currently hosted on [homesrv01.dev.lan](/marcio.fernandes/homesrv01.dev.lan).
 
-Currently using [gitea actions](./.gitea/workflows/deploy.yml) and portainer stack with git reference and webhook for continuous deploy.
+<!-- omit in toc -->
+## Table of Contents
+
+- [Docker](#docker)
+  - [Volumes](#volumes)
+    - [data](#data)
+    - [music](#music)
+- [Editing and Maintenance](#editing-and-maintenance)
+- [Links](#links)
+
+<!-- 
+## Clients
+
+### Home Assistant
+
+(for more information check [home asistant git repo](/marcio.fernandes/homeassist#lms))
+
+
+## Plugins
+
+*Not included on [continuous deploy](#editing-and-maintenance)* 
+-->
+
+## Docker
+
+[Docker Compose](./docker-compose.yml)
+
+### Volumes
+
+#### data
+
+Contains LMS persistent data. Not included on [continuous deploy](#editing-and-maintenance).
+
+#### music
+
+External volume, linked to a network share. Not included on [continuous deploy](#editing-and-maintenance)
+
+For more information check [homesrv01 git repo](/marcio.fernandes/homsrv01.dev.lan#lms).
+
+## Editing and Maintenance
+
+<!-- 
+Currently using [gitea actions](./.gitea/workflows/deploy.yml) and portainer stack (name: lms) with git reference and webhook for continuous deploy.
+-->
+
+Using code server [docker container on homesrv01](/marcio.fernandes/homsrv01.dev.lan#code-server) for editing this repo and docker volumes files.
+
+## Links
+
+- Lyrion Music Server - Official
+  - [WebSite](https://lyrion.org)
+  - [github](https://github.com/LMS-Community)
+  - [Community Forum](https://forums.slimdevices.com/)
+  - [Docker Hub](https://hub.docker.com/r/lmscommunity/lyrionmusicserver)
\ No newline at end of file