JeroenED/imageproxy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improved readability in README

Browse Source 
Indented the list of options for better readability and updated the example URL to use a .svg file instead of a .png.
This commit is contained in:
Jeroen De Meerleer 2024-07-23 14:00:45 +02:00
parent 8fbbccfa21
commit 3c787b9236
Signed by: JeroenED
GPG Key ID: 28CCCB8F62BFADD6
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -13,15 +13,15 @@ Small image proxy based on [intervetion/image](https://image.intervention.io) to
Several options can be used
fill => Background color
w => the resulting width of the image
h => the resulting height of the image
cw => the resulting canvas width of the image
ch => the resulting canvas height of the image
url => the url of the original image (required)
fill => Background color
w => the resulting width of the image
h => the resulting height of the image
cw => the resulting canvas width of the image
ch => the resulting canvas height of the image
url => the url of the original image (required)
** example **
Following will resize the gitea logo png to 600 by 600 with extra padding up to 800 by 800 and a light green background
"deploy_url"?fill=f2ffe5&w=600&h=600&cw=800&ch=800&url=https://about.gitea.com/gitea.png
"deploy_url"?fill=f2ffe5&w=600&h=600&cw=800&ch=800&url=https://about.gitea.com/gitea.svg