Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve installation instructions #50

Merged
merged 1 commit into from
Nov 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
105 changes: 94 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,20 +41,98 @@ con un script creado con ***`Python`*** y ***`Playwright`***.

## Instalación | Actualización

Para [`instalar` | `actualizar` ], ejecuta el siguiente comando en tu terminal:
### Con **`poetry`** **(recomendado)**

```console
pip install -U git+https://github.com/ivansaul/codigo_facilito_downloader.git
```
<details>

Instala las dependencias de `playwright`:
<summary>Instrucciones</summary>

```console
playwright install chromium
```
## Instalación

> [!IMPORTANT]
> El script utiliza ***`ffmpeg`***, como un subproceso, así que asegúrate de tener instalado y actualizado.
Puedes instalar `poetry` en tu sistema siguiendo estos pasos:

1. Instala `poetry` en tu sistema:

```console
pip install poetry
```

2. Clona el repositorio:

```console
git clone https://github.com/ivansaul/codigo_facilito_downloader.git
```

3. Entra al directorio del repositorio:

```console
cd codigo_facilito_downloader
```

4. Instala el paquete:

```console
poetry install
```

5. Instala las dependencias de `playwright`:

```console
playwright install chromium
```

## Actualización

1. Entra al directorio del repositorio:

```console
cd codigo_facilito_downloader
```

2. Actualiza el repositorio:

```console
git reset --hard HEAD
git pull
```

3. Actualiza el paquete:

```console
poetry install
```

4. Actualiza las dependencias de `playwright`:

```console
playwright install chromium
```

</details>

### Con **`pip`**

<details>

<summary>Instrucciones</summary>

## Instalación y actualización

1. Instala el paquete:

```console
pip install -U git+https://github.com/ivansaul/codigo_facilito_downloader.git
```

2. Instala las dependencias de `playwright`:

```console
playwright install chromium
```

</details>

<br>

<details>

Expand Down Expand Up @@ -137,7 +215,7 @@ facilito download <url> [OPCIONES]

Opciones:

- `--quality`, `-q`: Especifica la calidad del video (por defecto: `MAX`). Opciones disponibles: `[max|1080p|720p|480p|360p|min]`.
- `--quality`, `-q`: Especifica la calidad del video (por defecto: `max`). Opciones disponibles: `[max|1080p|720p|480p|360p|min]`.
- `--override`, `-w`: Sobrescribe el archivo existente si existe (por defecto: `False`).
- `--threads`, `-t`: Número de hilos a utilizar (por defecto: `10`).

Expand All @@ -159,6 +237,11 @@ facilito download URL -q 720p -t 5

<br>

> [!IMPORTANT]
> El script utiliza ***`ffmpeg`***, como un subproceso, así que asegúrate de tener instalado y actualizado.

<br>

> [!TIP]
> Si por algún motivo se cancela la descarga, vuelve a ejecutar `facilito download <url>` para retomar la descarga.

Expand Down