diff --git a/README.md b/README.md index e658b07..90e492a 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@

pybalt

-
Python module and CLI tool for downloading media through Cobalt processing instances.
-
+
CLI tool and python module for downloading media through Cobalt processing instances.
- [![GitHub stars](https://img.shields.io/github/stars/nichind/pybalt.svg)](https://github.com/nichind/pybalt) [![Get on PyPI](https://img.shields.io/pypi/v/pybalt.svg)](https://pypi.org/project/pybalt/) [![Last commit](https://img.shields.io/github/last-commit/nichind/pybalt.svg)](https://github.com/nichind/pybalt) [![Pip module installs total downloads](https://img.shields.io/pypi/dm/pybalt.svg)](https://pypi.org/project/pybalt/) + [![GitHub stars](https://img.shields.io/github/stars/nichind/pybalt.svg)](https://github.com/nichind/pybalt) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) - +

CLI Preview

- + https://github.com/user-attachments/assets/cf5fd9a9-520b-4970-b8c2-42baa80d7523


Installation

-

Install using PowerShell

+

Install pybalt using PowerShell on Windows

+Downloads [install.bat](./install.bat) and executes it. ```powershell powershell -Command "Invoke-WebRequest -Uri https://raw.githubusercontent.com/nichind/pybalt/main/install.bat -OutFile install.bat; .\install.bat" ``` @@ -35,7 +35,7 @@ This should create aliases `pybalt` and `cobalt` in your shell. Try running `cobalt -h` to see the help message. -If for some reason it didn't work, try using it with Python: +If for some reason it didn't work, try using it directly from python package: ```shell python -m pybalt @@ -55,7 +55,7 @@ COBALT_API_KEY=YOUR_API_KEY COBALT_USER_AGENT=YOUR_USER_AGENT ``` -By default, pybalt attempts to parse any available instance for you. It is recommended to host your own instance or request an `API key` from someone else's instance. +> By default, pybalt attempts to use any available instance for you provided by [public list of instances](https://instances.cobalt.best). It is recommended to host your own instance or request an `API key` from someone else's instance.

As a CLI

@@ -64,7 +64,7 @@ By default, pybalt attempts to parse any available instance for you. It is recom Every command here uses the `cobalt` alias; you can also use `pybalt` or `python -m pybalt`. -By default, all downloads are saved in the user's downloads folder `~/Downloads`, or the one specified by the `--folder` flag. +By default, all downloads are saved in the user's downloads folder `~/Downloads`, or the one specified by the `-f` (`-folder`) flag. Get a list of all available commands by running: @@ -122,8 +122,8 @@ cobalt -pl 'https://youtube.com/playlist?list=PL_93TBqf4ymR9GsuI9W4kQ-G3WM7d2Tqj

As a module

-
+

Download video from URL