The configuration section in README.md does not show the defaults, but rather some other values. It's often wise to combine the two things: showing defaults and showing config structure. What can be done with regard to this matter:
- Values can be replaced with the default ones. This should be mentioned in the text, something like "here are the defaults that you can replace".
- Non-default values can be kept, comments with defaults can be added.
The configuration section in README.md does not show the defaults, but rather some other values. It's often wise to combine the two things: showing defaults and showing config structure. What can be done with regard to this matter: