Merge pull request #10 from Atemu/sb-readme

Reorganise, reword and extend README
This commit is contained in:
poly 2020-12-01 14:55:39 -07:00 committed by GitHub
commit e50a40bc85
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -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)
## 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).