add license and readme

This commit is contained in:
creations 2025-03-29 08:17:45 -04:00
parent 53b7bf2c34
commit 12741ce4ba
Signed by: creations
GPG key ID: 8F553AA4320FC711
2 changed files with 74 additions and 0 deletions

53
README.md Normal file
View file

@ -0,0 +1,53 @@
# grabit
A simple script to take a screenshot, upload it to atums.world, and copy the link to the clipboard.
## Requirements
### Wayland
- `grim`
- `slurp`
- `wl-copy`
- `curl`, `jq`
### X11
- `flameshot`
- `xclip`
- `curl`, `jq`
### Other
- `xdg-utils`
- Python 3
## Setup
Copy the `env.example` and change values, all are required but headers
```bash
cp .env.example .env
```
## Usage
Take a screenshot and upload:
```bash
./upload.sh
```
Upload an existing file:
```bash
./upload.sh path/to/image.png
```
Upload clipboard image:
```bash
./upload.sh -c
```
## Notes
- Detects Wayland/X11 automatically.
- Copies the upload link to the clipboard.
- Shows a preview of the uploaded image.
## License
[MIT](LICENSE)