From adc7e1efe916c24660e61a60ffe7623aee6d20e7 Mon Sep 17 00:00:00 2001 From: dmunozv04 <39565245+dmunozv04@users.noreply.github.com> Date: Fri, 24 Jan 2025 16:52:21 +0100 Subject: [PATCH] Pass markdownlint --- .github/ISSUE_TEMPLATE/bug_report.md | 3 ++- .github/ISSUE_TEMPLATE/feature_request.md | 6 ++++-- .markdownlintignore | 2 +- README.md | 26 ++++++++++++++--------- 4 files changed, 23 insertions(+), 14 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 0c27e71..e3e4ab7 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,8 @@ assignees: '' --- -Before opening an issue make sure that there are no duplicates and that you are on the latest version. +Before opening an issue make sure that there are no duplicates and that you are +on the latest version. **Describe the bug** A clear and concise description of what the bug is. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..d5a8d55 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,13 +8,15 @@ assignees: '' --- **Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +A clear and concise description of what the problem is. Ex. I'm always +frustrated when [...] **Describe the solution you'd like** A clear and concise description of what you want to happen. **Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +A clear and concise description of any alternative solutions or features you've +considered. **Additional context** Add any other context or screenshots about the feature request here. diff --git a/.markdownlintignore b/.markdownlintignore index f0c4298..0e4b780 100644 --- a/.markdownlintignore +++ b/.markdownlintignore @@ -1 +1 @@ -LICENSE.md \ No newline at end of file +LICENSE.md diff --git a/README.md b/README.md index 523f4ad..3e61a0d 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ [![GitHub Release](https://img.shields.io/github/v/release/dmunozv04/isponsorblocktv?logo=GitHub&style=flat)](https://github.com/dmunozv04/iSponsorBlockTV/releases/latest) [![GitHub Repo stars](https://img.shields.io/github/stars/dmunozv04/isponsorblocktv?style=flat)](https://github.com/dmunozv04/isponsorblocktv) -Skip sponsor segments in YouTube videos playing on a YouTube TV device (see below for compatibility details). +Skip sponsor segments in YouTube videos playing on a YouTube TV device (see +below for compatibility details). This project is written in asynchronous python and should be pretty quick. @@ -13,8 +14,6 @@ This project is written in asynchronous python and should be pretty quick. Check the [wiki](https://github.com/dmunozv04/iSponsorBlockTV/wiki/Installation) -Warning: docker armv7 builds have been deprecated. Amd64 and arm64 builds are still available. - ## Compatibility Legend: ✅ = Working, ❌ = Not working, ❔ = Not tested @@ -39,18 +38,23 @@ Open an issue/pull request if you have tested a device that isn't listed here. ## Usage Run iSponsorBlockTV on a computer that has network access. -Auto discovery will require the computer to be on the same network as the device during setup. -The device can also be manually added to iSponsorBlockTV with a YouTube TV code. This code can be found in the settings page of your YouTube application. +Auto discovery will require the computer to be on the same network as the device +during setup. +The device can also be manually added to iSponsorBlockTV with a YouTube TV code. +This code can be found in the settings page of your YouTube application. -It connects to the device, watches its activity and skips any sponsor segment using the [SponsorBlock](https://sponsor.ajay.app/) API. +It connects to the device, watches its activity and skips any sponsor segment +using the [SponsorBlock](https://sponsor.ajay.app/) API. It can also skip/mute YouTube ads. ## Libraries used -- [pyytlounge](https://github.com/FabioGNR/pyytlounge) Used to interact with the device +- [pyytlounge](https://github.com/FabioGNR/pyytlounge) Used to interact with the + device - asyncio and [aiohttp](https://github.com/aio-libs/aiohttp) - [async-cache](https://github.com/iamsinghrajat/async-cache) -- [Textual](https://github.com/textualize/textual/) Used for the amazing new graphical configurator +- [Textual](https://github.com/textualize/textual/) Used for the amazing new + graphical configurator - [ssdp](https://github.com/codingjoe/ssdp) Used for auto discovery ## Projects using this project @@ -68,8 +72,10 @@ It can also skip/mute YouTube ads. ## Contributors - [dmunozv04](https://github.com/dmunozv04) - creator and maintainer -- [HaltCatchFire](https://github.com/HaltCatchFire) - updated dependencies and improved skip logic -- [Oxixes](https://github.com/oxixes) - added support for channel whitelist and minor improvements +- [HaltCatchFire](https://github.com/HaltCatchFire) - updated dependencies and + improved skip logic +- [Oxixes](https://github.com/oxixes) - added support for channel whitelist and + minor improvements ## License