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