diff --git a/README.md b/README.md index a6e26b6..3c26dd3 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,32 @@ Scrapes youtube comments and checks whether a user commented on the given videos # Installation -## GitHub +## Install with pip ``` -pip install git+https://github.com/rly0nheart/youtube-comment-scraper +pip install git+https://github.com/bellingcat/youtube-comment-scraper ``` -## Docker Image +## Build from source +1. Clone the repository ``` -docker pull rly0nheart/youtube-comment-scraper +git clone https://github.com/bellingcat/youtube-comment-scraper +``` +2. Move to the cloned project's directory +``` +cd youtube-comment-scraper +``` +3. Install the `build` package (If not already installed) +``` +pip install build +``` +4. Build the project +``` +python -m build +``` +5. Install the built package +``` +pip install dist/*.whl ``` - # Usage ## PyPi Package @@ -19,20 +35,14 @@ docker pull rly0nheart/youtube-comment-scraper youtube_comment_scraper ``` -## Docker Image -``` -docker run -it rly0nheart/youtube-comment-scraper -``` - - ## 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 +If you would like `youtube-comment-scraper` and would like to show support, you could Buy A Coffee for the developer using the button below Buy Me A Coffee -Your support will be much appreciated! +Your support will be much appreciated!😊