Update README.md

README.md

@@ -427,7 +427,9 @@ to `false`:
   - A custom path for html reports. This defaults to the htmlcov report in the excoveralls lib.
 - `minimum_coverage`
   - When set to a number greater than 0, this setting causes the `mix coveralls` and `mix coveralls.html` tasks to exit with a status code of 1 if test coverage falls below the specified threshold (defaults to 0). This is useful to interrupt CI pipelines with strict code coverage rules. Should be expressed as a number between 0 and 100 signifying the minimum percentage of lines covered.
-  - Can also be set to a nested object of filepath and minimum coverage key-value pairs. If this is the case, then `mix coveralls` and `mix coveralls.html` tasks will exit with a status code of 1 if test coverage falls below the specified threshold for any of the configured files.
+- `minimum_file_coverage`
+  - A JSON object whose keys are filepaths, and whose values are numbers. When a filepath specifies a minimum coverage greater than 0, any `mix coveralls` or `mix coveralls.html` tasks will exit with a status code of 1 if that file's test coverage falls below the configured threshold. Should be expressed as a number between 0 and 100 signifying the minimum percentage of lines covered for any given file.
+  - When used in conjunction with `minimum_coverage`, overall project coverage is checked first before individual file coverages are checked.
 - `html_filter_full_covered`
   - A boolean, when `true` files with 100% coverage are not shown in the HTML report. Default to `false`.
 
@@ -450,6 +452,9 @@ Example configuration file:
     "output_dir": "cover/",
     "template_path": "custom/path/to/template/",
     "minimum_coverage": 90,
+    "minimum_file_coverage": {
+      "lib/my_app/example.ex": 100
+    },
     "xml_base_dir": "custom/path/for/xml/reports/",
     "html_filter_full_covered": true
   }