From 12741ce4baa5aec71f0af863c01682fc3f7812ba Mon Sep 17 00:00:00 2001
From: creations <creations@creations.works>
Date: Sat, 29 Mar 2025 08:17:45 -0400
Subject: [PATCH] add license and readme

---
 LICENSE   | 21 +++++++++++++++++++++
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 74 insertions(+)
 create mode 100644 LICENSE
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..262da5b
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Creation's
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..dab300c
--- /dev/null
+++ b/README.md
@@ -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)