diff --git a/README.md b/README.md index c871d5c..ddf870c 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,33 @@ # YouTube-Comment-Scraper -A script to scrape youtube comments and checks whether a user commented on the given videos +Scrape youtube comments and checks whether a user commented on the given videos # Installation -**1. Clone the project** +## PyPI Package ``` -git clone https://github.com/rly0nheart/YouTube-Comment-Scraper.git +pip install youtube-comment-scraper ``` -**2. Move to YouTube-Comment-Scraper directory** +## Docker Image ``` -cd YouTube-Comment-Scraper +docker pull rly0nheart/youtube-comment-scraper ``` -**3. Install dependencies** -## Note -``` -pip install -r requirements.txt -``` # Usage +## PyPi Package ``` -python scraper.py +youtube_comment_scraper ``` -> *Alternatively, you could grant execution permission to the downloader and run it as shown below* - -**1. Grant execution permission** +## Docker Image ``` -chmod +x scraper.py +docker run -it rly0nheart/youtube-comment-scraper ``` -**2. Run scraper.py** -``` -./scraper.py -``` ## Note > Upon run, the scraper will first check for updates. If found, users will be prompted to download the updates +>> The scraper uses [Egbert Bouman's](https://github.com/egbertbouman) [YouTube-Comment-Downloader](https://github.com/egbertbouman/youtube-comment-downloader) to get the comments # Donations If you would like to donate, you could Buy A Coffee for the developer using the button below