From 33f0de23b592b77a8e18c0a67915fec3bdaceaf5 Mon Sep 17 00:00:00 2001
From: Syping <syping@syping.de>
Date: Fri, 24 Oct 2025 02:47:57 +0200
Subject: [PATCH] add README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..19a1eae
--- /dev/null
+++ b/README.md
@@ -0,0 +1,36 @@
+## ragephoto-cli
+Open Source Rage Photo CLI based on libragephoto
+
+- Read/Write RAGE Photos with get/set commands
+- Support for stdin/stdout in JPEG option and output
+
+#### Build ragephoto-cli
+
+```sh
+git clone https://github.com/Syping/ragephoto-cli
+dotnet publish -c Release ragephoto-cli
+```
+
+#### How to Use ragephoto-cli
+
+```sh
+# Exporting JPEG
+ragephoto-cli get PGTA5123456789 --output photo.jpg
+
+# Getting Format
+ragephoto-cli get PGTA5123456789 format
+
+# Getting JSON
+ragephoto-cli get PGTA5123456789 json
+
+# Getting Title
+ragephoto-cli get PGTA5123456789 title
+
+# Replacing JPEG (Patching Signature is required after)
+ragephoto-cli set PGTA5123456789 --jpeg photo.jpg
+ragephoto-cli set PGTA5123456789 --json "$(ragephoto-cli get PGTA5123456789 json \
+    | jq -c ".sign = $(ragephoto-cli get PGTA5123456789 sign)")"
+
+# Updating Title
+ragephoto-cli set PGTA5123456789 --title "New Photo Title"
+```