From 986e7f25642bd36e4be02cb46f8cc6ecc36a7fd7 Mon Sep 17 00:00:00 2001
From: fzzinchemical <mathys162002@gmail.com>
Date: Thu, 13 Nov 2025 22:26:27 +0100
Subject: [PATCH] Added README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7eb5fa4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,20 @@
+# Monkeycrawl
+
+A small script to crawl Twitter/X that uses [twscrape](https://github.com/vladkens/twscrape).
+
+Use at your own discretion. Do not multithread or risk getting banned or worse.
+
+## Usage
+```cmd
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+Add cookies, accounts and passwords to `.env.local` and remove `.local` file extension.
+
+```cmd
+python main.py
+```
+
+When exiting the script the file `tweets.json` will contain the scraped tweets.
\ No newline at end of file