From a5fcc33d07d05959079584706bf9dd876f6e2e1a Mon Sep 17 00:00:00 2001
From: Marco D'Aleo <m.daleo404@gmail.com>
Date: Sat, 8 Nov 2025 09:04:49 +0000
Subject: [PATCH] Copy main README to resrm/

---
 resrm/README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 66 insertions(+)
 create mode 100644 resrm/README.md

diff --git a/resrm/README.md b/resrm/README.md
new file mode 100644
index 0000000..629f7ca
--- /dev/null
+++ b/resrm/README.md
@@ -0,0 +1,66 @@
+# resrm
+
+**resrm** is a safe, drop-in replacement for the Linux `rm` command with **undo/restore support**.  
+It moves files to a per-user _trash_ instead of permanently deleting them, while still allowing full `sudo` support for root-owned files.
+
+---
+
+## Features
+
+- Move files and directories to a **trash folder** instead of permanent deletion  
+- Restore deleted files by **short ID or exact basename**  
+- Empty trash safely  
+- Supports `-r`, `-f`, `-i`, `--perma` options  
+- Works with `sudo` for root-owned files  
+
+---
+
+## Installation
+
+Install via Poetry:
+
+```bash
+poetry add resrm
+```
+
+Or clone the repo and install locally:
+
+```bash
+git clone https://github.com/mdaleo404/resrm.git
+cd resrm
+poetry install
+```
+
+## Usage
+
+```bash
+# Move files to trash
+resrm file1 file2
+
+# Recursive remove of a directory
+resrm -r mydir
+
+# Force remove (ignore nonexistent)
+resrm -f file
+
+# Interactive remove
+resrm -i file
+
+# Permanent delete (bypass trash)
+resrm --perma file
+
+# List trash entries
+resrm -l
+
+# Restore a file by ID or basename
+resrm --restore <id|name>
+
+# Empty the trash permanently
+resrm --empty
+```
+
+## Trash Location
+
+Normal users: `~/.local/share/resrm/files`
+
+Root user: `/root/.local/share/resrm/files`
\ No newline at end of file