Update README

This commit is contained in:
Jarrian
2023-09-09 12:35:03 +08:00
parent 783294a1ed
commit e50fcb956d
2 changed files with 23 additions and 5 deletions

View File

@@ -1,2 +1,2 @@
TWITTER_USERNAME=# Your Twitter USERNAME TWITTER_USERNAME=# Your Twitter Handle
TWITTER_PASSWORD=# Your Twitter Password TWITTER_PASSWORD=# Your Twitter Password

View File

@@ -2,22 +2,40 @@
## Setup ## Setup
1. Install dependencies
```bash ```bash
pip install -r requirements.txt pip install -r requirements.txt
``` ```
2. Rename `.env.example` to `.env`.
3. Open .env and update environment variables
```bash
TWITTER_USERNAME=# Your Twitter Handle (e.g. @username)
TWITTER_PASSWORD=# Your Twitter Password
```
## Usage ## Usage
- Basic usage
```bash ```bash
python scraper python scraper
``` ```
### Arguments - Setting maximum number of tweets. defaults to `50`.
```bash
python scraper --tweets=500 # Scrape 500 Tweets
```
### Options and Arguments
```bash ```bash
usage: python scraper [arg] usage: python scraper [arg]
Arguments Description Arguments Description
--tweets : No. of tweets. 50 default. --tweets : No. of tweets. default: 50.
e.g. --tweets=500 e.g. --tweets=500
``` ```