From cfc056f108c72d6ec051a9ec5304354f16697a4c Mon Sep 17 00:00:00 2001
From: jpk <jpk@goatpr0n.de>
Date: Sun, 8 Jan 2023 10:09:25 +0100
Subject: [PATCH] Added README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1095ad1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Wallpaper Sorter
+
+Sort wallpapers by their resolution.
+
+## Installation
+
+### Pipx
+
+```
+pipx install git+https://git.goatpr0n.de/public/wpsrt.git
+```
+
+## Usage
+
+```shell
+wpsrt --help
+Usage: wpsrt [OPTIONS] [SOURCE] [TARGET]
+
+Options:
+  --help  Show this message and exit.
+```
+
+**SOURCE** currently defaults to `~/Pictures/wallpapers` and **TARGET** to `~/Pictures/wallpapers/by-resolution`.