Update README with logo and badges, add logo image

This commit is contained in:
√(noham)²
2025-12-20 11:55:50 +01:00
parent 0f0fb975a6
commit 9b253e815d
3 changed files with 18 additions and 15 deletions

View File

@@ -1,6 +1,6 @@
MIT License
Copyright (c) 2025 Rivoirard Noham
Copyright (c) 2025 NohamR
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

View File

@@ -1,3 +1,18 @@
<p align="center">
<img src="docs/images/logo.png" width="64"> <a href="https://github.com/NohamR/OqeeRewind">OqeeRewind</a>
<br/>
<sup><em>Oqee TV Live Downloader</em></sup>
</p>
<p align="center">
<a href="https://github.com/NohamR/OqeeRewind/blob/master/LICENSE">
<img src="https://img.shields.io/:license-MIT-blue.svg" alt="License">
</a>
<a href="https://github.com/astral-sh/uv">
<img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Onyx-Nostalgia/uv/refs/heads/fix/logo-badge/assets/badge/v0.json" alt="Manager: uv">
</a>
</p>
# OqeeRewind - Oqee TV Live Downloader
## Legal Warning
@@ -8,10 +23,10 @@ This application is not endorsed by or affiliated with Oqee. This application en
### Prerequisites
- Python 3.9+
- [uv](https://docs.astral.sh/uv/) (recommended) or pip
- [uv](https://docs.astral.sh/uv/)
- Go ([Installation Guide](https://go.dev/doc/install))
- ffmpeg
- mp4ff-decrypt
- [mp4ff-decrypt](https://github.com/Eyevinn/mp4ff)
```bash
go install github.com/Eyevinn/mp4ff/cmd/mp4ff-decrypt@latest
```
@@ -19,18 +34,11 @@ go install github.com/Eyevinn/mp4ff/cmd/mp4ff-decrypt@latest
### Steps
Clone the repository and install dependencies:
**Using uv (recommended - faster):**
```bash
git clone https://github.com/NohamR/OqeeRewind && cd OqeeRewind
uv sync
```
**Using pip:**
```bash
git clone https://github.com/NohamR/OqeeRewind && cd OqeeRewind
pip install -r requirements.txt
```
### Configuration
Create a `.env` file in the root directory and add your Oqee credentials (otherwise the script will try to use IP login first):
```bash
@@ -55,11 +63,6 @@ If you run the script without arguments, it will guide you through channel selec
uv run main.py
```
**Using Python directly:**
```bash
python main.py
```
### CLI Mode
You can automate the download by providing arguments.

BIN
docs/images/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 878 KiB