zhaarey/unshackle
1
0
Fork 0
mirror of https://github.com/unshackle-dl/unshackle.git synced 2025-10-23 15:11:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: update .gitignore and enhance README with planned features

Browse Source
This commit is contained in:
Andy
2025-07-18 18:30:55 +00:00
parent 1a49d288f8
commit 6037b640ac
2 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@@ -1,4 +1,6 @@
# unshackle # unshackle
unshackle.yaml
unshackle.yml
*.mkv *.mkv
*.mp4 *.mp4
*.exe *.exe
@@ -23,6 +25,7 @@ unshackle/certs/
unshackle/WVDs/ unshackle/WVDs/
unshackle/PRDs/ unshackle/PRDs/
temp/ temp/
services/
# Byte-compiled / optimized / DLL files # Byte-compiled / optimized / DLL files
__pycache__/ __pycache__/

17
README.md
View File

@@ -43,9 +43,19 @@ uvx unshackle --help # or just `unshackle` once PATH updated
> [!NOTE] > [!NOTE]
> After installation, you may need to add the installation path to your PATH environment variable if prompted. > After installation, you may need to add the installation path to your PATH environment variable if prompted.
>
> **Recommended:** Use `uv run unshackle` instead of direct command execution to ensure proper virtual environment activation. > **Recommended:** Use `uv run unshackle` instead of direct command execution to ensure proper virtual environment activation.
## Planned Features
- 🌈 **HDR10+DV Hybrid Support** - Allow support for hybrid HDR10+ and Dolby Vision.
- 🖥️ **Web UI Access & Control** - Manage and control unshackle from a modern web interface.
- 🔄 **Sonarr/Radarr Interactivity** - Direct integration for automated personal downloads.
- ⚙️ **Better ISM Support** - Improve on ISM support for multiple services
- 🐳 **Docker Image** - Prepared Docker Image with everything ready to go.
- 🔉 **ATMOS** - Better Atmos Support/Selection
- 🎵 **Music** - Cleanup Audio Tagging using the [tags.py](unshackle/core/utils/tags.py) for artist/track name etc.
### Basic Usage ### Basic Usage
```shell ```shell
@@ -94,8 +104,3 @@ Please refrain from spam or asking for questions that infringe upon a Service's
This software is licensed under the terms of [GNU General Public License, Version 3.0](LICENSE). This software is licensed under the terms of [GNU General Public License, Version 3.0](LICENSE).
You can find a copy of the license in the LICENSE file in the root folder. You can find a copy of the license in the LICENSE file in the root folder.
---
[Export Cookies]: https://addons.mozilla.org/addon/export-cookies-txt
[Open Cookies.txt]: https://chrome.google.com/webstore/detail/gdocmgbfkjnnpapoeobnolbbkoibbcif