From e7e9186e207f1180d2c6c53f64e45074d254ce67 Mon Sep 17 00:00:00 2001 From: Erick Date: Sat, 24 Aug 2024 02:38:07 -0400 Subject: [PATCH 1/2] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f32ffd8..78521ee 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # Beacon Snatch -Beacon Snatch is a command-line interface (CLI) tool designed to authenticate, browse, and download video content from the Beacon streaming platform. The CLI offers both direct command execution and an interactive mode for ease of use. +Beacon Snatch is a library and command-line interface (CLI) tool designed to authenticate, browse, and download video content from the Beacon streaming platform. The CLI offers both direct command execution and an interactive mode for ease of use. -It is also a python library for more advanced usage. +Beacon Snatch is a project made quickly that uses a headless browser to obtain the video streams to download, so dont expect anything fast or secure. Use at your own risk. ## Features From 4f5b013204fc6cc746cd2178af3d6fd511ef62ed Mon Sep 17 00:00:00 2001 From: Erick Date: Sat, 24 Aug 2024 03:30:22 -0400 Subject: [PATCH 2/2] Update README.md --- README.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 78521ee..3ea2ab6 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,16 @@ Beacon Snatch is a project made quickly that uses a headless browser to obtain t To install Beacon Snatch, first clone the repository and then install it using `pip`: ```bash -git clone https://github.com/retrozelda/beacon_snatch.git -cd beacon_snatch +git clone https://github.com/retrozelda/beacon-snatch.git +cd beacon-snatch pip install . ``` + +or simply +``` +pip install beacon-snatch +``` + This will install the required dependencies listed in the dependencies file and make the CLI accessible via the `beacon-snatch` command. ## CLI Usage