diff --git a/README.md b/README.md index 920f548..2a2a479 100644 --- a/README.md +++ b/README.md @@ -4,4 +4,33 @@ Simple extension to easily maintain aspect ratio while changing dimensions. Install via the extensions tab on the [AUTOMATIC1111 webui](https://github.com/AUTOMATIC1111/stable-diffusion-webui). +## Main features: +- Scale to maximum width or dimension + - Upon clicking, the dimensions will scale the highest value to the maximum configured value + - Aspect ratio will be maintained, the smaller or equivalent value will be scaled to match +- Scale by percentage + - Upon clicking, the current dimensions will be multiplied by the given percentage, with aspect ratio maintained + - i.e `150% of 512x512 = 768x768` `75% of 512x256 = 384x192` etc. + +Screenshot: + +![user-interface.png](docs%2Fuser-interface.png) + +## Settings: + +- Expand by default + - Determines whether the 'Aspect Ratio Helper' accordion expands by default +- Show maximum width of height button + - Self-explanatory +- Maximum width or height default + - Self-explanatory +- Show percentage buttons + - Self-explanatory +- Percentage buttons + - Comma separated list of percentages + - i.e `25, 50, 75, 125, 150, 175, 200` `50, 125, 300` etc. + +Screenshot: + +![settings.png](docs%2Fsettings.png) diff --git a/docs/settings.png b/docs/settings.png new file mode 100644 index 0000000..78b81ed Binary files /dev/null and b/docs/settings.png differ diff --git a/docs/user-interface.png b/docs/user-interface.png new file mode 100644 index 0000000..2476f5f Binary files /dev/null and b/docs/user-interface.png differ