mtkennerly / dunamai

Dynamic versioning library and CLI
https://dunamai.readthedocs.io/en/latest
MIT License
312 stars 24 forks source link

Documentation for output substitutions #50

Closed mfulgo closed 1 year ago

mfulgo commented 1 year ago

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.

mtkennerly commented 1 year ago

Hi! I've added a section to the README to cover this. Thanks for the feedback :)

mfulgo commented 1 year ago

Looks great, thanks!