From 304ae21af90a6f159c765a9c8341b457aeb65841 Mon Sep 17 00:00:00 2001 From: Manuel <30572287+manuel-rw@users.noreply.github.com> Date: Sat, 30 Dec 2023 19:40:58 +0100 Subject: [PATCH] docs: #6 add installation instructions --- README.md | 50 +++++++++++++++++++++++++++++++++++--------------- 1 file changed, 35 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 4b7b9d6..1fa303a 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,31 @@ Custom CSS theme for Jellyfin (plus a backdrops supported version) --- -Scyfin Complete Theme +## Table of contents + +- [Installation](#installation) +- [Themes](#themes) + - [Complete theme](#complete-theme) + - [Complete theme + without static drawer](#complete-theme-without-static-drawer-and-with-backdrop) + - [Complete theme + without static drawer + with backdrop](#complete-theme-without-static-drawer) + +## Installation +1. Click on ``Settings`` in the navigation bar +2. Click on ``Dashboard`` below ``Administration`` +3. Click on ``General`` below ``Server``. +4. Scroll to the bottom of the page and enter the custom CSS code of your desired theme. +5. Click ``Save`` +6. Press ``CTRL`` + ``F5`` + +> [!WARNING] +> Only add 1 version of the theme, do not add both the normal Scyfin theme and the backdrops supported version together + +## Themes +### Complete theme + +```css +@import url('https://cdn.jsdelivr.net/gh/loof2736/scyfin@v1.0.10/CSS/css-scyfin/scyfin-theme.css'); +``` scyfin1 scyfin2 @@ -14,28 +38,24 @@ Scyfin Complete Theme scyfin4 scyfin5 -`@import url('https://cdn.jsdelivr.net/gh/loof2736/scyfin@v1.0.10/CSS/css-scyfin/scyfin-theme.css');` +### Complete theme without static drawer and with backdrop -Options (Add these below the full theme) -- Disable static left drawer `@import url('https://cdn.jsdelivr.net/gh/loof2736/scyfin@v1.0.10/CSS/css-scyfin/disable-static-drawer.css');` -- Disable static left drawer (BACKDROP VERSION) `@import url('https://cdn.jsdelivr.net/gh/loof2736/scyfin@v1.0.10/CSS/css-scyfin/disable-static-drawer-backdrop.css');` +```css +@import url('https://cdn.jsdelivr.net/gh/loof2736/scyfin@v1.0.10/CSS/css-scyfin/disable-static-drawer.css'); +``` ---- +### Complete theme without static drawer -Scyfin Complete Theme - Backdrops Supported +```css +@import url('https://cdn.jsdelivr.net/gh/loof2736/scyfin@v1.0.10/CSS/css-scyfin/disable-static-drawer-backdrop.css'); +``` -Note - +> [!NOTE] +> Backdrops need to be enabled in Jellyfin (`Settings` > `Display` > `Backdrop`) for backdrop supported version to display properly - Only add 1 version of the theme, do not add both the normal Scyfin theme and the backdrops supported version together - - Backdrops need to be enabled in Jellyfin (Settings > Display > Backdrops) for backdrop supported version to display properly scyfin-backdrop1 scyfin-backdrop2 scyfin-backdrop3 -`@import url('https://cdn.jsdelivr.net/gh/loof2736/scyfin@v1.0.10/CSS/css-scyfin/scyfin-theme-backdrop.css');` -Options (Add these below the full theme) -- Disable static left drawer `@import url('https://cdn.jsdelivr.net/gh/loof2736/scyfin@v1.0.10/CSS/css-scyfin/disable-static-drawer.css');` -- Disable static left drawer (BACKDROP VERSION) `@import url('https://cdn.jsdelivr.net/gh/loof2736/scyfin@v1.0.10/CSS/css-scyfin/disable-static-drawer-backdrop.css');`