From 6b390463ca774e46abdfddbbcd6fe029f0137d6c Mon Sep 17 00:00:00 2001
From: djairoh <djairoh@mykolab.com>
Date: Mon, 27 Apr 2026 19:33:11 +0200
Subject: [PATCH] ft: readme + instructions

---
 README.md   | 21 +++++++++++++++++++++
 env.example |  4 ++++
 2 files changed, 25 insertions(+)
 create mode 100644 README.md
 create mode 100644 env.example

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c4dadf2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+# Tum(bler del)eter
+
+Python script that uses the Tumblr API to remove all "empty reblogs" for a tumblr account's main blog.
+
+Empty reblogs are defined as posts on the account where both of the following hold:
+1) the last addition in the reblog trail is NOT made by the account.
+2) the account did not add any tags.
+
+# Running
+
+You're going to need to get authentication for the Tumblr API.
+First set up an [application](https://www.tumblr.com/oauth/apps).
+
+Then copy the `env.example` file to `.env` and populate the four required values.
+After that just run the program using `uv run main.py` and give it time to run.
+
+# Rate limits
+
+Tumblr's API has hard-coded rate limits, so the script will wait on timeout and try again at a later point.
+Note that as a result, running the script may take a while (especially on blogs with a large number of posts).
+
diff --git a/env.example b/env.example
new file mode 100644
index 0000000..87b0f74
--- /dev/null
+++ b/env.example
@@ -0,0 +1,4 @@
+CONSUMER_KEY=""
+CONSUMER_SECRET=""
+OAUTH_TOKEN=""
+OAUTH_SECRET=""