From ea58bc43285640d112af5de4213aa2d6245ab6d7 Mon Sep 17 00:00:00 2001 From: Penelope Gomez / Pogmommy Date: Tue, 7 Feb 2023 20:26:57 -0700 Subject: [PATCH] Update README.md update documentation --- README.md | 26 +++++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b81e3c0..aa9708f 100644 --- a/README.md +++ b/README.md @@ -32,17 +32,33 @@ npm install ## Usage +### Single User Scraper + ``` -node ./TwitToMast.js [username] [tweet count] [debug level] [disable posts] +node ./TwitToMast.js [username] [tweet count] [debug level] [disable posts] [print header] ``` - `username (string)`: the twitter handle of the user whose account will be scraped - `tweet count (integer)`: the number of enabled tweets that will be scraped from the targeted account -- `debug level (0-2)`: Level of output that will be printed on screen. +- `debug level (0-2)`: Level of output that will be printed on screen - 0 or omitted: the program will to run silently (no output on screen) - - 1: The program will print what tasks it is working on and errors, but nothing more. - - 2: The program will print what tasks it is working on and errors, as well as various other information necessary for troubleshooting. -- `disable posts ('noWrite')`: disable posting tweets to Mastodon, useful for testing + - 1: The program will print what tasks it is working on and errors, but nothing more + - 2: The program will print what tasks it is working on and errors, as well as various other information necessary for troubleshooting +- `disable posts ('write','noWrite')`: enable/disable posting tweets to Mastodon, useful for testing +- `print header ('printHeader')`: enable attaching a header with the user's name, twitter handle, and link to tweet + +[Example](https://tech.lgbt/@pogmommy) +### Multi User Scraper + +Configure twitter accounts to be scraped in `usernameslist.txt` before running the script +``` +node ./multi.js [tweet count] [debug level] [disable posts] [print header] +``` +- Arguments have the same effect as listed above +- **Note that username is NOT used in this script** + +[Example](https://techhub.social/@twitterscraper) + ## How Types of Tweets are handled - Self Posts