From 5c61005be5f9ccbf9cb41ca5af8d5cb108183995 Mon Sep 17 00:00:00 2001 From: Fascinated Date: Sun, 9 Apr 2023 12:39:58 +0100 Subject: [PATCH] update readme --- README.md | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a6f818b..540b6c7 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ This is a PHP script that lets you easily upload screenshots taken with the ShareX app to your website. ShareX is a popular screenshot tool for Windows that allows you to take screenshots, annotate them, and share them online. -To use this script, you need to upload it to your website and configure it with a secret key. Once that's done, you can configure ShareX to use your script as the upload target. This will let you quickly and easily upload your screenshots to your website without having to manually upload them one by one. +## Features -The script will check if the secret key is correct, if the file was uploaded correctly, and will convert images to the webp format if they are in a supported format such as png or jpeg. If everything is okay, the script will return a JSON response containing a URL to the uploaded file on your website. If there's an error, it will return an error message. +- Uploads screenshots to your website using ShareX. +- Can automatically convert screenshots to WebP format. + +## Installation + +1. Find somewhere to host the script. +2. Upload the files to your server. +3. Edit the `upload.php` file to configure the script. +4. Add the custom uploader to ShareX. +5. Configure the custom uploader in ShareX. +6. Test it! + +## Help + +If you need help, you can contact me on Discord at `Fascinated#7668`.