Update and rename README to README.md

Refactored README in proper Markdown
This commit is contained in:
0n1cOn3 2024-11-06 07:47:49 +01:00 committed by GitHub
parent a7b00026c4
commit bf026c64dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 47 additions and 8 deletions

8
README
View file

@ -1,8 +0,0 @@
yt-dlp-proxy is a script to find the best proxy for yt-dlp to avoid throttling and bans
How to use:
1. (Optional, do only if you have problems with next step) Open terminal and run "yt-dlp-proxy update". This will make a speed test for each free proxy and choose the best one.
2. Use script as you use yt-dlp! Just pass all arguments to yt-dlp-proxy, instead of yt-dlp. For example, "yt-dlp-proxy --format bv[vcodec^=avc!]+ba https://www.youtube.com/watch?v=bQB0_4BG-9F"
3. After some time proxy may become slow. In this case just run command from 1st step.
Also you can copy symlink "yt-dlp-proxy_link" to the dir you want for easier access to the script

47
README.md Normal file
View file

@ -0,0 +1,47 @@
## yt-dlp-proxy Guide
yt-dlp-proxy is a script designed to help you avoid throttling and bans by automatically selecting the best proxy for yt-dlp.
#### Howto start with yt-dlp-proxy
```yt-dlp-proxy update```
This will also perform a speed test for each free proxy and select the best one available.
#### Download with yt-dlp-proxy
Use yt-dlp-proxy just like you would use yt-dlp! Pass all the arguments to yt-dlp-proxy instead.
Example:
```yt-dlp-proxy --format bv[vcodec^=avc!]+ba https://www.youtube.com/watch?v=bQB0_4BG-9F```
If the proxy becomes slow over time, rerun the command from Step 1 to refresh the proxy selection.
### Optional: Symlink and systemwide installation
Setting Up a Symlink for Easier Access
To make yt-dlp-proxy easier to access from anywhere, you can create a symlink in */usr/bin* or another directory in your systems PATH.
___
**Option 1:** Create a Symlink in /usr/bin
Open a terminal.
Run the following command, replacing */path/to/yt-dlp-proxy* with the actual path to the yt-dlp-proxy script:
```sudo ln -s /path/to/yt-dlp-proxy /usr/bin/yt-dlp-proxy```
Now you can use yt-dlp-proxy from any directory in the terminal.
___
**Option 2:** Install to */usr/bin*
If you prefer, you can directly move the yt-dlp-proxy script to /usr/bin:
Open a terminal.
Run the following command, again replacing /path/to/yt-dlp-proxy with the path to the script:
```sudo install /path/to/yt-dlp-proxy /usr/bin/yt-dlp-proxy```
This will copy yt-dlp-proxy to /usr/bin, making it globally accessible.
Now, you can simply type yt-dlp-proxy from any location in the terminal to use the script.
___