Skip to content

Commit 73f0192

Browse files
committed
Add documentation about the behavior of configuration file loading.
1 parent 3b56f05 commit 73f0192

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/02-Configuration.md

+6
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ You may configure various options within `php-semver-checker` to make them more
1212
}
1313
```
1414

15+
## Configuration file
16+
17+
By default, `php-semver-checker` will search for a file called `php-semver-checker.yml` within the current directory. If one is found, it'll read its configuration from that file.
18+
19+
If no `php-semver-checker.yml` file exists but a `php-semver-checker.yml.dist` file exists (for distribution purpose), configuration will be read from that file.
20+
1521
## Configuration sections
1622

1723
The following describes every section of the configuration in more details in order to allow you to customize `php-semver-checker` to your liking.

0 commit comments

Comments
 (0)