Docs: Add docs for allowedSize option

tgxn · Jun 29, 2021 · d104981 · d104981
1 parent 5c23ef5
commit d104981
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -55,16 +55,17 @@ Config file is `config.json` and has the following mandatory properties:
 
 And the following non-mandatory options:
 
-| Option               | Default | Purpose                                                              |
-| -------------------- | ------- | -------------------------------------------------------------------- |
-| `enabled`            | `true`  |                                                                      |
-| `allowedExtensions`  | `*`     | `Array` of extension to allow, _(empty or omitted for all)_          |
-| `ignoredExtensions`  | _None_  | `Array` of extensions to ignore                                      |
-| `seriesCaseFormat`   | _None_  | A property of the [Case](https://www.npmjs.com/package/case) library |
-| `linkSubtitles`      | `false` | Should subtitle files be copied alongside media files?               |
-| `subtitleExtensions` | _None_  | Extensions to link with media                                        |
-| `useHighestQuality`  | `false` | Should a higher-quality release replace a lower one?                 |
-| `strictType`         | _None_  | Whether this config block should only accept `movies` or `series`    |
+| Option               | Default | Purpose                                                                      |
+| -------------------- | ------- | ---------------------------------------------------------------------------- |
+| `enabled`            | `true`  |                                                                              |
+| `allowedExtensions`  | `*`     | `Array` of extension to allow, _(empty or omitted for all)_                  |
+| `ignoredExtensions`  | _None_  | `Array` of extensions to ignore                                              |
+| `seriesCaseFormat`   | _None_  | A property of the [Case](https://www.npmjs.com/package/case) library         |
+| `linkSubtitles`      | `false` | Should subtitle files be copied alongside media files?                       |
+| `subtitleExtensions` | _None_  | Extensions to link with media                                                |
+| `useHighestQuality`  | `false` | Should a higher-quality release replace a lower one?                         |
+| `strictType`         | _None_  | Whether this config block should only accept `movies` or `series`            |
+| `allowedSize`        | _None_  | `Array` of Minimum and Maximum (if required) file sizes, in MB. `[50, 5000]` |
 
 You can also specify an array of config objects if you have different file types/directories to scan. See [`config.example.json`](https://github.com/tgxn/media-organize/blob/master/config.example.json) for an example of this.
 

diff --git a/config.example.json b/config.example.json
@@ -4,6 +4,7 @@
         "allowedExtensions": ["mkv", "avi"],
         "strictType": "series",
         "seriesCaseFormat": "capital",
+        "allowedSize": [50, 1500],
         "targetPath": "../sorted/Series",
         "targetFormat": "{nameOptYear}/Season {season}/Episode {episode}.{extension}"
     },
@@ -15,6 +16,7 @@
         "linkSubtitles": true,
         "subtitleExtensions": [".srt"],
         "strictType": "movie",
+        "allowedSize": [1200],
         "targetPath": "../sorted/Movies",
         "targetFormat": "Movies/{nameOptYear}/{name}.{extension}"
     }