Merge pull request #119 from jasonpatrickellykrause/readme-formatting

Formatting updates to README

Author: RandomNinjaAtk

README.md

@@ -1,17 +1,21 @@
 # arr-scripts
+
 Official Home of the scripts that were previously packaged with the "Extended" containers. Designed to be easily implemented/added to [Linuxserver.io](https://www.linuxserver.io/) containers.
 
-# Usage
- [Radarr Instructions](https://github.com/RandomNinjaAtk/arr-scripts/tree/main/radarr/readme.md)<br>
- [Sonarr Instructions](https://github.com/RandomNinjaAtk/arr-scripts/tree/main/sonarr/readme.md)<br>
- [Lidarr Instructions](https://github.com/RandomNinjaAtk/arr-scripts/tree/main/lidarr/readme.md)<br>
- [Readarr Instructions](https://github.com/RandomNinjaAtk/arr-scripts/tree/main/readarr/readme.md)<br>
+## Usage
+
+ [Radarr Instructions](https://github.com/RandomNinjaAtk/arr-scripts/tree/main/radarr/readme.md)  
+ [Sonarr Instructions](https://github.com/RandomNinjaAtk/arr-scripts/tree/main/sonarr/readme.md)  
+ [Lidarr Instructions](https://github.com/RandomNinjaAtk/arr-scripts/tree/main/lidarr/readme.md)  
+ [Readarr Instructions](https://github.com/RandomNinjaAtk/arr-scripts/tree/main/readarr/readme.md)  
  [SABnzbd Instructions](https://github.com/RandomNinjaAtk/arr-scripts/tree/main/sabnzbd#/readme.md)
 
-# WARNING
-DO NOT USE PORTAINER, it is known to not work and typcally breaks things... From the various discussions I've seen in the Arr communities and Linuxserver.io, they tend to trend on saying to avoid it... If your using portainer and this is not functioning as expected, that is likely your problem.... (Example: https://github.com/RandomNinjaAtk/arr-scripts/discussions/57)
+## WARNING
+
+DO NOT USE PORTAINER, it is known to not work and typically breaks things... From the various discussions I've seen in the Arr communities and Linuxserver.io, they tend to trend on saying to avoid it... If your using portainer and this is not functioning as expected, that is likely your problem.... (Example: <https://github.com/RandomNinjaAtk/arr-scripts/discussions/57>)
+
+Also see here: <https://wiki.servarr.com/docker-guide#portainer>
 
-Also see here: https://wiki.servarr.com/docker-guide#portainer
+## Support Info
 
-# Support Info
-Scripts are provided as-is... Generally, if a script works one time, it will work everytime, that is the nature of scripts... So if you're experiencing an issue that has not been previously reported and is more likely a technical problem of some sort, it is more than likely caused by user error... 
+Scripts are provided as-is... Generally, if a script works one time, it will work everytime, that is the nature of scripts... So if you're experiencing an issue that has not been previously reported and is more likely a technical problem of some sort, it is more than likely caused by user error...

lidarr/readme.md

@@ -1,21 +1,23 @@
-# Requirements
+# README
 
-Container: https://docs.linuxserver.io/images/docker-lidarr<br>
+## Requirements
 
-# Installation/setup
+Container: <https://docs.linuxserver.io/images/docker-lidarr>  
 
-1. Add 2 volumes to your container <br>
-   `/custom-services.d` and `/custom-cont-init.d` (do not map to the same local folder...) <br>
-   Docker Run Example: <br>
-   `-v /path/to/preferred/local/folder-01:/custom-services.d` <br>
+## Installation/setup
+
+1. Add 2 volumes to your container
+   `/custom-services.d` and `/custom-cont-init.d` (do not map to the same local folder...)
+   Docker Run Example:
+   `-v /path/to/preferred/local/folder-01:/custom-services.d`
    `-v /path/to/preferred/local/folder-02:/custom-cont-init.d`
-2. Download the [script_init.bash](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/lidarr/scripts_init.bash) ([Download Link](https://raw.githubusercontent.com/RandomNinjaAtk/arr-scripts/main/lidarr/scripts_init.bash)) and place it into the following folder: <br>
+2. Download the [script_init.bash](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/lidarr/scripts_init.bash) ([Download Link](https://raw.githubusercontent.com/RandomNinjaAtk/arr-scripts/main/lidarr/scripts_init.bash)) and place it into the following folder:
    `-v /path/to/preferred/local/folder-02:/custom-cont-init.d`
 3. Start your container and wait for the application to load
 4. Optional: Customize the configuration by modifying the following file `/config/extended.conf`
 5. Restart the container
 
-# Updating
+## Updating
 
 Updating is a bit more combersum. To update, do the following:
 
@@ -25,7 +27,7 @@ Updating is a bit more combersum. To update, do the following:
 
 This configuration does its best to update everything automatically, but with how the core system is designed, the new scripts will not take affect until a second restart is completed because the container copies/uses the previous versions of the script for execution on the first restart.
 
-# Features
+## Features
 
 <table>
   <tr>
@@ -36,8 +38,8 @@ This configuration does its best to update everything automatically, but with ho
     <td><img src="https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/video.png" width="150"></td>
   </tr>
  </table>
- 
-* Downloading **Music** using online sources for use in popular applications (Plex/Kodi/Emby/Jellyfin): 
+
+* Downloading **Music** using online sources for use in popular applications (Plex/Kodi/Emby/Jellyfin):
   * Completely automated
   * Searches for downloads based on Lidarr's album missing & cutoff list
   * Downloads using a third party download client automatically
@@ -81,22 +83,22 @@ For more details, visit the [Wiki](https://github.com/RandomNinjaAtk/arr-scripts
 
 ### Audio & Video (Plex Example)
 
-![](https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/plex.png)
+![plex](https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/plex.png)
 
 ### Video Example (Kodi)
 
-![](https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/kodi-music-videos.png)
-
-# Credits
-
-- [LinuxServer.io Team](https://github.com/linuxserver/docker-lidarr)
-- [Lidarr](https://lidarr.audio/)
-- [Beets](https://beets.io/)
-- [Deemix download client](https://deemix.app/)
-- [Tidal-Media-Downloader client](https://github.com/yaronzz/Tidal-Media-Downloader)
-- [r128gain](https://github.com/desbma/r128gain)
-- [Algorithm Implementation/Strings/Levenshtein distance](https://en.wikibooks.org/wiki/Algorithm_Implementation/Strings/Levenshtein_distance)
-- [ffmpeg](https://ffmpeg.org/)
-- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
-- [SMA Conversion/Tagging Automation Script](https://github.com/mdhiggins/sickbeard_mp4_automator)
-- [Freyr](https://github.com/miraclx/freyr-js)
+![kodi](https://github.com/RandomNinjaAtk/docker-lidarr-extended/raw/main/.github/kodi-music-videos.png)
+
+## Credits
+
+* [LinuxServer.io Team](https://github.com/linuxserver/docker-lidarr)
+* [Lidarr](https://lidarr.audio/)
+* [Beets](https://beets.io/)
+* [Deemix download client](https://deemix.app/)
+* [Tidal-Media-Downloader client](https://github.com/yaronzz/Tidal-Media-Downloader)
+* [r128gain](https://github.com/desbma/r128gain)
+* [Algorithm Implementation/Strings/Levenshtein distance](https://en.wikibooks.org/wiki/Algorithm_Implementation/Strings/Levenshtein_distance)
+* [ffmpeg](https://ffmpeg.org/)
+* [yt-dlp](https://github.com/yt-dlp/yt-dlp)
+* [SMA Conversion/Tagging Automation Script](https://github.com/mdhiggins/sickbeard_mp4_automator)
+* [Freyr](https://github.com/miraclx/freyr-js)

radarr/readme.md

@@ -1,24 +1,31 @@
-# Requirements
-Container: https://docs.linuxserver.io/images/docker-radarr<br>
-
-# Installation/setup
-1. Add 2 volumes to your container <br>
-  `/custom-services.d` and `/custom-cont-init.d` (do not map to the same local folder...) <br> 
-  Docker Run Example: <br>
-  `-v /path/to/preferred/local/folder-01:/custom-services.d` <br>
+# README
+
+## Requirements
+
+Container: <https://docs.linuxserver.io/images/docker-radarr>  
+
+## Installation/setup
+
+1. Add 2 volumes to your container
+  `/custom-services.d` and `/custom-cont-init.d` (do not map to the same local folder...)
+  Docker Run Example:
+  `-v /path/to/preferred/local/folder-01:/custom-services.d`
   `-v /path/to/preferred/local/folder-02:/custom-cont-init.d`
-3. Download the [script_init.bash](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/radarr/scripts_init.bash) ([Download Link](https://raw.githubusercontent.com/RandomNinjaAtk/arr-scripts/main/radarr/scripts_init.bash)) and place it into the following folder: `/custom-cont-init.d`
-4. Start your container and wait for the application to load
-5. Optional: Customize the configuration by modifying the following file `/config/extended.conf`
-6. Restart the container
+1. Download the [script_init.bash](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/radarr/scripts_init.bash) ([Download Link](https://raw.githubusercontent.com/RandomNinjaAtk/arr-scripts/main/radarr/scripts_init.bash)) and place it into the following folder: `/custom-cont-init.d`
+1. Start your container and wait for the application to load
+1. Optional: Customize the configuration by modifying the following file `/config/extended.conf`
+1. Restart the container
+
+## Updating
 
-# Updating
 Updating is a bit more combersum. To update, do the following:
+
 1. Download/update your local `/config/extended.conf` file with the latest options from: [extended.conf](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/radarr/extended.conf)
-2. Restart the container, wait for it to fully load the application.
-3. Restart the container again, for the new scripts to activate.
+1. Restart the container, wait for it to fully load the application.
+1. Restart the container again, for the new scripts to activate.
+
+## Features
 
-# Features
 <table>
   <tr>
     <td><img src="https://raw.githubusercontent.com/RandomNinjaAtk/unraid-templates/master/randomninjaatk/img/radarr.png" width="200"></td>
@@ -27,7 +34,7 @@ Updating is a bit more combersum. To update, do the following:
   </tr>
  </table>
 
-* Downloading **Movie Trailers** and **Extras** using online sources for use in popular applications (Plex/Kodi/Emby/Jellyfin): 
+* Downloading **Movie Trailers** and **Extras** using online sources for use in popular applications (Plex/Kodi/Emby/Jellyfin):
   * Connects to Radarr to automatically download trailers for Movies in your existing library
   * Downloads videos using yt-dlp automatically
   * Names videos correctly to match Plex/Emby/Jellyfin naming convention
@@ -38,25 +45,24 @@ Updating is a bit more combersum. To update, do the following:
 * Recyclarr built-in
   * Auto configures Custom Formats
   * Auto configures Custom Format Scores
-  * Auto configures optimzed quality definitions
+  * Auto configures optimized quality definitions
 * Plex Notify Script
   * Reduce Plex scanning by notifying Plex the exact folder to scan
 * Queue Cleaner Script
   * Automatically removes downloads that have a "warning" or "failed" status that will not auto-import into Radarr, which enables Radarr to automatically re-search for the Title
- 
+
 For more details, visit the [Wiki](https://github.com/RandomNinjaAtk/arr-scripts/wiki)
 
-  
 ### Plex Example
-![](https://raw.githubusercontent.com/RandomNinjaAtk/docker-amtd/master/.github/amvtd-plex-example.jpg)
 
+![amvtd](https://raw.githubusercontent.com/RandomNinjaAtk/docker-amtd/master/.github/amvtd-plex-example.jpg)
 
+## Credits
 
-# Credits
-- [ffmpeg](https://ffmpeg.org/)
-- [yt-dlp](https://github.com/yt-dlp/yt-dlp)
-- [linuxserver/radarr](https://github.com/linuxserver/docker-radarr) Base docker image
-- [Radarr](https://radarr.video/)
-- [The Movie Database](https://www.themoviedb.org/)
-- [Recyclarr](https://github.com/recyclarr/recyclarr)
-- Icons made by <a href="http://www.freepik.com/" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon"> www.flaticon.com</a>
+* [ffmpeg](https://ffmpeg.org/)
+* [yt-dlp](https://github.com/yt-dlp/yt-dlp)
+* [linuxserver/radarr](https://github.com/linuxserver/docker-radarr) Base docker image
+* [Radarr](https://radarr.video/)
+* [The Movie Database](https://www.themoviedb.org/)
+* [Recyclarr](https://github.com/recyclarr/recyclarr)
+* Icons made by [Freepik](https://www.freepik.com/) from [Flaticon](ttps://www.flaticon.com)

readarr/readme.md

@@ -1,22 +1,28 @@
-# Readarr
+
+# README
+
 ## Requirements
-Container: https://hub.docker.com/r/linuxserver/readarr<br>
+
+Container: <https://hub.docker.com/r/linuxserver/readarr>  
 
 ## Installation/setup
-1. Add 2 volumes to your container <br>
-  `/custom-services.d` and `/custom-cont-init.d` (do not map to the same local folder...) <br> 
-  Docker Run Example: <br>
-  `-v /path/to/preferred/local/folder-01:/custom-services.d` <br>
+
+1. Add 2 volumes to your container
+  `/custom-services.d` and `/custom-cont-init.d` (do not map to the same local folder...)
+  Docker Run Example:
+  `-v /path/to/preferred/local/folder-01:/custom-services.d`
   `-v /path/to/preferred/local/folder-02:/custom-cont-init.d`
-3. Download the [script_init.bash](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/readarr/scripts_init.bash) ([Download Link](https://raw.githubusercontent.com/RandomNinjaAtk/arr-scripts/main/readarr/scripts_init.bash)) and place it into the following folder: `/custom-cont-init.d`
-4. Start your container and wait for the application to load
-5. Optional: Customize the configuration by modifying the following file `/config/extended.conf`
-6. Restart the container
+1. Download the [script_init.bash](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/readarr/scripts_init.bash) ([Download Link](https://raw.githubusercontent.com/RandomNinjaAtk/arr-scripts/main/readarr/scripts_init.bash)) and place it into the following folder: `/custom-cont-init.d`
+1. Start your container and wait for the application to load
+1. Optional: Customize the configuration by modifying the following file `/config/extended.conf`
+1. Restart the container
 
 # Updating
+
 Updating is a bit more combersum. To update, do the following:
+
 1. Download/update your local `/config/extended.conf` file with the latest options from: [extended.conf](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/readarr/extended.conf)
-2. Restart the container, wait for it to fully load the application.
-3. Restart the container again, for the new scripts to activate.
+1. Restart the container, wait for it to fully load the application.
+1. Restart the container again, for the new scripts to activate.
 
 This configuration does its best to update everything automatically, but with how the core system is designed, the new scripts will not take affect until a second restart is completed because the container copies/uses the previous versions of the script for execution on the first restart.

sabnzbd/readme.md

@@ -1,22 +1,29 @@
-# Requirements
-Container: [https://docs.linuxserver.io/images/docker-sabnzbd](https://docs.linuxserver.io/images/docker-sabnzbd)<br>
+# README
 
-# Installation/setup
-1. Add volume to your container <br>
-  `/custom-cont-init.d` <br>
-  Docker Run Example: <br>
+## Requirements
+
+Container: [https://docs.linuxserver.io/images/docker-sabnzbd](https://docs.linuxserver.io/images/docker-sabnzbd)  
+
+## Installation/setup
+
+1. Add volume to your container
+  `/custom-cont-init.d`
+  Docker Run Example:
   `-v /path/to/preferred/local/directory:/custom-cont-init.d`
 1. Download the [script_init.bash](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/sabnzbd/scripts_init.bash) ([Download Link](https://raw.githubusercontent.com/RandomNinjaAtk/arr-scripts/main/sabnzbd/scripts_init.bash)) and place it into the following folder: `/custom-cont-init.d`
 1. Start your container and wait for the application to load
 1. Optional: Customize the configuration by modifying the following file `/config/extended.conf`
 1. Add the `/config/scripts` folder to the "Scripts Folder" folder setting in SABnzbd
-1. Add `video.bash` or `audio.bash` script to the appropriate SABnzbd category 
+1. Add `video.bash` or `audio.bash` script to the appropriate SABnzbd category
+
+## Updating
 
-# Updating
 Updating is a bit more combersum. To update, do the following:
+
 1. Download/update your local `/config/extended.conf` file with the latest options from: [extended.conf](https://github.com/RandomNinjaAtk/arr-scripts/blob/main/sabnzbd/extended.conf)
-2. Restart the container, wait for it to fully load the application.
-3. Restart the container again, for the new scripts to activate.
+1. Restart the container, wait for it to fully load the application.
+1. Restart the container again, for the new scripts to activate.
+
+## Additional Information
 
-# Additional Information
 For more details, visit the [Wiki](https://github.com/RandomNinjaAtk/arr-scripts/wiki)