From 374452512b3c0f3c773240cab7924160cca8c9f9 Mon Sep 17 00:00:00 2001 From: Atemu Date: Tue, 1 Dec 2020 14:58:46 +0100 Subject: [PATCH] Reorganise, reword and extend README --- README.md | 22 ++++++++++++++-------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 077978621..88df6d458 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,18 @@ # NewPipe x SponsorBlock -This is a fork of NewPipe with a basic implementation of SponsorBlock. +A fork of [NewPipe](https://github.com/TeamNewPipe/NewPipe) with [SponsorBlock](https://sponsor.ajay.app/) functionality. -## Where can I download this? -When the next version of NewPipe is released, see the [Releases](https://github.com/polymorphicshade/NewPipe/releases) section for an APK. +![01](.github/images/preview01.gif) +![02](.github/images/preview02.gif) -## Will this ever be officially merged into the NewPipe? -Nope. See [here](https://newpipe.schabi.org/blog/pinned/newpipe-and-online-advertising/) for more information. +The implementation is still a bit basic but it generally works pretty well. -## Preview -![01](.github/images/preview01.gif) -![02](.github/images/preview02.gif) \ No newline at end of file +## How can I get this? +Builds will be uploaded in the [Releases](https://github.com/polymorphicshade/NewPipe/releases) section. Please download the APK from the newest release and install it on your device. + +## Why isn't this in upstream NewPipe? +[The developer team](https://github.com/TeamNewPipe) behind the official NewPipe decided that they do not want to include this kind of functionality in their app. See https://newpipe.schabi.org/blog/pinned/newpipe-and-online-advertising/ and https://github.com/TeamNewPipe/NewPipe/pull/3205 for more information and discussion. + +We obviously disagree but we respect their decision and continue to offer SponsorBlock in NewPipe via this fork. + +## Bugs +Please do not report bugs encountered while using this fork to the upstream developers. Either try to reproduce the bug in vanilla NewPipe and then report it (preferred) or [create a bug report in our repo](https://github.com/polymorphicshade/NewPipe/issues/new?assignees=&labels=bug&template=bug_report.md).