add readme

This commit is contained in:
2025-01-21 01:42:47 +13:00
parent 75f7a28b60
commit 278d0a56c4
2 changed files with 57 additions and 2 deletions

15
README.md Normal file
View File

@ -0,0 +1,15 @@
## Twitter scraper
Scrape user's tweets :D
### Usage:
`tweets = TweetsScraper().get_tweets_anonymous("<user_id>")`
returns a list of tweets from the user as viewed from a logged-out session. Will only return 100 tweets (not necessarily the most recent)
`tweets = TweetsScraper().get_tweets("<user_id>")`
not implemented yet, will get tweets as a logged in user
### Tweet object
Contains the text of the tweet, along with the timestamp and some stats (like count, repost count, views, etc)