Update README
This commit is contained in:
@@ -1,2 +1,2 @@
|
||||
TWITTER_USERNAME=# Your Twitter USERNAME
|
||||
TWITTER_USERNAME=# Your Twitter Handle
|
||||
TWITTER_PASSWORD=# Your Twitter Password
|
||||
|
||||
22
README.md
22
README.md
@@ -2,22 +2,40 @@
|
||||
|
||||
## Setup
|
||||
|
||||
1. Install dependencies
|
||||
|
||||
```bash
|
||||
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
|
||||
|
||||
- Basic usage
|
||||
|
||||
```bash
|
||||
python scraper
|
||||
```
|
||||
|
||||
### Arguments
|
||||
- Setting maximum number of tweets. defaults to `50`.
|
||||
|
||||
```bash
|
||||
python scraper --tweets=500 # Scrape 500 Tweets
|
||||
```
|
||||
|
||||
### Options and Arguments
|
||||
|
||||
```bash
|
||||
usage: python scraper [arg]
|
||||
|
||||
Arguments Description
|
||||
--tweets : No. of tweets. 50 default.
|
||||
--tweets : No. of tweets. default: 50.
|
||||
e.g. --tweets=500
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user