Rtch/imgbb-uploader
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[Add] Brought documentation up to date with recent changes. This project

Browse Source 
is prety much complete now. Have fun with it. Feel free to send patches.
This commit is contained in:
Ritchie Cunningham 2025-04-27 13:25:51 +01:00
parent f55e57f083
commit b3de100aed
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -19,6 +19,7 @@ Ideal for quickly sharing screenshots or images in environments like IRC without
* Optionally output and copy the URL in Markdown format. * Optionally output and copy the URL in Markdown format.
* Optionally output and copy the URL in orgmode format. * Optionally output and copy the URL in orgmode format.
* Takes screenshot of selected region. * Takes screenshot of selected region.
* Takes screenshot of selected display.
* Copies the resulting URL to the X11 clipboard. * Copies the resulting URL to the X11 clipboard.
* Provides desktop notifications for progress and success/failure (optional). * Provides desktop notifications for progress and success/failure (optional).
@ -43,6 +44,10 @@ Make sure you have the following command-line tools installed:
```bash ```bash
sudo apt install notify-send # Debian (often in libnotify-bin). sudo apt install notify-send # Debian (often in libnotify-bin).
``` ```
* **scrot (Optional)**: Used for taking screenshots.
``` bash
sudo apt install scrot # Debian.
```
## Installation ## Installation
@ -88,6 +93,8 @@ This script requires a **free API key** from ImgBB:
* `-n, --name NAME`: Set a custom filename for the uploaded image on ImgBB. * `-n, --name NAME`: Set a custom filename for the uploaded image on ImgBB.
* `--markdown`: Output and copy the URL in Markdown image format: `![](URL)` * `--markdown`: Output and copy the URL in Markdown image format: `![](URL)`
* `--org`: Output and copy the URL in Orgmode image format: `[[url][alt text]]` * `--org`: Output and copy the URL in Orgmode image format: `[[url][alt text]]`
* `-s, --select`: Take screenshot of selected area for upload.
* `-M, --monitor NUM`: Take screenshot of monitor NUM (e.g., 0, 1) for upload.
* `-h, --help`: Show the help message and exit. * `-h, --help`: Show the help message and exit.
**Examples:** **Examples:**
@ -108,6 +115,12 @@ imgbb -e 0
# Upload file, give it a name on ImgBB, get Markdown output/copy # Upload file, give it a name on ImgBB, get Markdown output/copy
imgbb -n "Cool Diagram" --markdown diagram.jpg imgbb -n "Cool Diagram" --markdown diagram.jpg
# Take screenshot of selected region and upload
imgbb -s
# Take screenshot of display #2 and upload
imgbb -M 2
# Show help # Show help
imgbb -h imgbb -h