diff --git a/.env.example b/.env.example index 1a6b9d5..e9510eb 100644 --- a/.env.example +++ b/.env.example @@ -1,2 +1,2 @@ -TWITTER_USERNAME=# Your Twitter USERNAME +TWITTER_USERNAME=# Your Twitter Handle TWITTER_PASSWORD=# Your Twitter Password diff --git a/README.md b/README.md index 5362cbc..949f975 100644 --- a/README.md +++ b/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. - e.g. --tweets=500 +Arguments Description +--tweets : No. of tweets. default: 50. + e.g. --tweets=500 ```