Update nixarr/recyclarr/default.nix

Co-authored-by: Rasmus Kirk <mail@rasmuskirk.com>

Author: elsbrock

nixarr/recyclarr/default.nix

@@ -65,9 +65,52 @@ in {
 
     configFile = mkOption {
       type = types.path;
-      description = "Path to the recyclarr YAML configuration file. See [Recyclarr's documentation](https://recyclarr.dev/wiki/yaml/config-reference) for more information.
+      description = ''
+        Path to the recyclarr YAML configuration file. See [Recyclarr's
+        documentation](https://recyclarr.dev/wiki/yaml/config-reference)
+        for more information.
+
+        The API keys for Radarr and Sonarr can be referenced in the config
+        file using the `RADARR_API_KEY` and `SONARR_API_KEY` environment
+        variables (with macro `!env_var`). The below example configuration
+        shows how these values can be used:
 
-      **Note:** the API keys for Radarr and Sonarr can be referenced in the config file using the `RADARR_API_KEY` and `SONARR_API_KEY` environment variables (with macro `!env_var`).";
+        ```yaml
+          sonarr:
+            series:
+              base_url: "http://localhost:8989"
+              api_key: !env_var SONARR_API_KEY
+              quality_definition:
+                type: series
+              delete_old_custom_formats: true
+              custom_formats:
+                - trash_ids:
+                    - 85c61753df5da1fb2aab6f2a47426b09 # BR-DISK
+                    - 9c11cd3f07101cdba90a2d81cf0e56b4 # LQ
+                    - 47435ece6b99a0b477caf360e79ba0bb # x265 (HD)
+                    - fbcb31d8dabd2a319072b84fc0b7249c # Extras
+                  assign_scores_to:
+                    - name: WEB-DL (1080p)
+                      score: -10000
+          radarr:
+            movies:
+              base_url: "http://localhost:7878"
+              api_key: !env_var RADARR_API_KEY
+              quality_definition:
+                type: movie
+              delete_old_custom_formats: true
+              custom_formats:
+                - trash_ids:
+                    - 570bc9ebecd92723d2d21500f4be314c # Remaster
+                    - eca37840c13c6ef2dd0262b141a5482f # 4K Remaster
+                    - e0c07d59beb37348e975a930d5e50319 # Criterion Collection
+                    - 9d27d9d2181838f76dee150882bdc58c # Masters of Cinema
+                    - db9b4c4b53d312a3ca5f1378f6440fc9 # Vinegar Syndrome
+                  assign_scores_to:
+                    - name: HD Bluray + WEB
+                      score: 25
+        ```
+      '';
       example = "./recyclarr.yaml";
     };
   };