Something I've struggled with a couple times here is knowing what options are available for substitutions in the custom output format and knowing what exactly each one mean. The list is available in the help (dunamai from any --help), but it'd be nice if it was also available here in the README, with an explanation of what each substitution means.
It's also unclear from the documentation as to whether or not substitutions are always included or if some substitutions would be omitted if the distance from a base tag is 0. (If not, that might be an interesting feature - defining an optional portion of a custom format...)
I'd be happy to make a PR to update the docs if you're interested.
Two thoughts around documentation...
Something I've struggled with a couple times here is knowing what options are available for substitutions in the custom output format and knowing what exactly each one mean. The list is available in the help (
dunamai from any --help
), but it'd be nice if it was also available here in the README, with an explanation of what each substitution means.It's also unclear from the documentation as to whether or not substitutions are always included or if some substitutions would be omitted if the distance from a base tag is 0. (If not, that might be an interesting feature - defining an optional portion of a custom format...)
I'd be happy to make a PR to update the docs if you're interested.