Skip to content

Commit d5985be

Browse files
opusforlife2triallaxPoolitzer
authored
Made some much needed changes to the ReadMe (#8372)
Co-authored-by: Mohammed Anas <triallax@tutanota.com> Co-authored-by: Poolitzer <github@poolitzer.eu>
1 parent dc7fce8 commit d5985be

1 file changed

Lines changed: 59 additions & 61 deletions

File tree

README.md

Lines changed: 59 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center"><a href="https://newpipe.net"><img src="assets/new_pipe_icon_5.png" width="150"></a></p>
22
<h2 align="center"><b>NewPipe</b></h2>
3-
<h4 align="center">A libre lightweight streaming frontend for Android.</h4>
3+
<h4 align="center">A libre lightweight streaming front-end for Android.</h4>
44

55
<p align="center"><a href="https://f-droid.org/packages/org.schabi.newpipe/"><img src="https://fdroid.gitlab.io/artwork/badge/get-it-on-en.svg" alt="Get it on F-Droid" height=80/></a></p>
66

@@ -13,15 +13,15 @@
1313
<a href="https://www.bountysource.com/teams/newpipe" alt="Bountysource bounties"><img src="https://img.shields.io/bountysource/team/newpipe/activity.svg?colorB=cd201f"></a>
1414
</p>
1515
<hr>
16-
<p align="center"><a href="#screenshots">Screenshots</a> &bull; <a href="#description">Description</a> &bull; <a href="#features">Features</a> &bull; <a href="#installation-and-updates">Installation and updates</a> &bull; <a href="#contribution">Contribution</a> &bull; <a href="#donate">Donate</a> &bull; <a href="#license">License</a></p>
16+
<p align="center"><a href="#screenshots">Screenshots</a> &bull; <a href="#supported-services">Supported Services</a> &bull; <a href="#description">Description</a> &bull; <a href="#features">Features</a> &bull; <a href="#installation-and-updates">Installation and updates</a> &bull; <a href="#contribution">Contribution</a> &bull; <a href="#donate">Donate</a> &bull; <a href="#license">License</a></p>
1717
<p align="center"><a href="https://newpipe.net">Website</a> &bull; <a href="https://newpipe.net/blog/">Blog</a> &bull; <a href="https://newpipe.net/FAQ/">FAQ</a> &bull; <a href="https://newpipe.net/press/">Press</a></p>
1818
<hr>
1919

2020
*Read this in other languages: [English](README.md), [Español](doc/README.es.md), [हिन्दी](doc/README.hi.md), [한국어](doc/README.ko.md), [Soomaali](doc/README.so.md), [Português Brasil](doc/README.pt_BR.md), [Polski](doc/README.pl.md), [日本語](doc/README.ja.md), [Română](doc/README.ro.md), [Türkçe](doc/README.tr.md), [正體中文](doc/README.zh_TW.md).*
2121

22-
<b>WARNING: THIS IS A BETA VERSION, THEREFORE YOU MAY ENCOUNTER BUGS. IF YOU DO, OPEN AN ISSUE VIA OUR GITHUB REPOSITORY.</b>
22+
<b>WARNING: THIS APP IS IN BETA, SO YOU MAY ENCOUNTER BUGS. IF YOU DO, OPEN AN ISSUE IN OUR GITHUB REPOSITORY BY FILLING OUT THE ISSUE TEMPLATE.</b>
2323

24-
<b>PUTTING NEWPIPE OR ANY FORK OF IT INTO THE GOOGLE PLAY STORE VIOLATES THEIR TERMS AND CONDITIONS.</b>
24+
<b>PUTTING NEWPIPE, OR ANY FORK OF IT, INTO THE GOOGLE PLAY STORE VIOLATES THEIR TERMS AND CONDITIONS.</b>
2525

2626
## Screenshots
2727

@@ -38,50 +38,53 @@
3838
[<img src="fastlane/metadata/android/en-US/images/tenInchScreenshots/shot_11.png" width=405>](fastlane/metadata/android/en-US/images/tenInchScreenshots/shot_11.png)
3939
[<img src="fastlane/metadata/android/en-US/images/tenInchScreenshots/shot_12.png" width=405>](fastlane/metadata/android/en-US/images/tenInchScreenshots/shot_12.png)
4040

41-
## Description
41+
### Supported Services
4242

43-
NewPipe does not use any Google framework libraries, nor the YouTube API. Websites are only parsed to fetch required info, so this app can be used on devices without Google services installed. Also, you don't need a YouTube account to use NewPipe, which is copylefted libre software.
43+
NewPipe currently supports these services:
4444

45-
### Features
45+
<!-- We link to the service websites separately to avoid people accidentally opening a website they didn't want to. -->
46+
* YouTube ([website](https://www.youtube.com/)) and YouTube Music ([website](https://music.youtube.com/)) ([wiki](https://en.wikipedia.org/wiki/YouTube))
47+
* PeerTube ([website](https://joinpeertube.org/)) and all its instances (open the website to know what that means!) ([wiki](https://en.wikipedia.org/wiki/PeerTube))
48+
* Bandcamp ([website](https://bandcamp.com/)) ([wiki](https://en.wikipedia.org/wiki/Bandcamp))
49+
* SoundCloud ([website](https://soundcloud.com/)) ([wiki](https://en.wikipedia.org/wiki/SoundCloud))
50+
* media.ccc.de ([website](https://media.ccc.de/)) ([wiki](https://en.wikipedia.org/wiki/Chaos_Computer_Club))
4651

47-
* Search videos
48-
* No Login Required
49-
* Display general info about videos
50-
* Watch YouTube videos
51-
* Listen to YouTube videos
52-
* Popup mode (floating player)
53-
* Select streaming player to watch video with
54-
* Download videos
55-
* Download audio only
56-
* Open a video in Kodi
57-
* Show next/related videos
58-
* Search YouTube in a specific language
59-
* Watch/Block age restricted material
60-
* Display general info about channels
61-
* Search channels
62-
* Watch videos from a channel
63-
* Orbot/Tor support (not yet directly)
64-
* 1080p/2K/4K support
65-
* View history
66-
* Subscribe to channels
67-
* Search history
68-
* Search/watch playlists
69-
* Watch as enqueued playlists
70-
* Enqueue videos
71-
* Local playlists
72-
* Subtitles
73-
* Livestream support
74-
* Show comments
52+
As you can see, NewPipe supports multiple video and audio services. Though it started off with YouTube, other people have added more services over the years, making NewPipe more and more versatile!
7553

76-
### Supported Services
54+
Partially due to circumstance, and partially due to its popularity, YouTube is the best supported out of these services. If you use or are familiar with any of these other services, please help us improve support for them! We're looking for maintainers for SoundCloud and PeerTube.
55+
56+
If you intend to add a new service, please get in touch with us first! Our [docs](https://teamnewpipe.github.io/documentation/) provide more information on how a new service can be added to the app and to the [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor).
7757

78-
NewPipe supports multiple services. Our [docs](https://teamnewpipe.github.io/documentation/) provide more info on how a new service can be added to the app and the extractor. Please get in touch with us if you intend to add a new one. Currently supported services are:
58+
## Description
7959

80-
* YouTube
81-
* SoundCloud \[beta\]
82-
* media.ccc.de \[beta\]
83-
* PeerTube instances \[beta\]
84-
* Bandcamp \[beta\]
60+
NewPipe works by fetching the required data from the official API (e.g. PeerTube) of the service you're using. If the official API is restricted (e.g. YouTube) for our purposes, or is proprietary, the app parses the website or uses an internal API instead. This means that you don't need an account on any service to use NewPipe.
61+
62+
Also, since they are free and open source software, neither the app nor the Extractor use any proprietary libraries or frameworks, such as Google Play Services. This means you can use NewPipe on devices or custom ROMs that do not have Google apps installed.
63+
64+
### Features
65+
66+
* Watch videos at resolutions up to 4K
67+
* Listen to audio in the background, only loading the audio stream to save data
68+
* Popup mode (floating player, aka Picture-in-Picture)
69+
* Watch live streams
70+
* Show/hide subtitles/closed captions
71+
* Search videos and audios (on YouTube, you can specify the content language as well)
72+
* Enqueue videos (and optionally save them as local playlists)
73+
* Show/hide general information about videos (such as description and tags)
74+
* Show/hide next/related videos
75+
* Show/hide comments
76+
* Search videos, audios, channels, playlists and albums
77+
* Browse videos and audios within a channel
78+
* Subscribe to channels (yes, without logging into any account!)
79+
* Get notifications about new videos from channels you're subscribed to
80+
* Create and edit channel groups (for easier browsing and management)
81+
* Browse video feeds generated from your channel groups
82+
* View and search your watch history
83+
* Search and watch playlists (these are remote playlists, which means they're fetched from the service you're browsing)
84+
* Create and edit local playlists (these are created and saved within the app, and have nothing to do with any service)
85+
* Download videos/audios/subtitles (closed captions)
86+
* Open in Kodi
87+
* Watch/Block age-restricted material
8588

8689
<!-- Hidden span to keep old links compatible. -->
8790
<span id="updates"></span>
@@ -90,41 +93,41 @@ NewPipe supports multiple services. Our [docs](https://teamnewpipe.github.io/doc
9093
You can install NewPipe using one of the following methods:
9194
1. Add our custom repo to F-Droid and install it from there. The instructions are here: https://newpipe.net/FAQ/tutorials/install-add-fdroid-repo/
9295
2. Download the APK from [GitHub Releases](https://github.com/TeamNewPipe/NewPipe/releases) and install it.
93-
3. Update via F-Droid. This is the slowest method of getting updates, as F-Droid must recognize changes, build the APK itself, sign it, then push the update to users.
96+
3. Update via F-Droid. This is the slowest method of getting updates, as F-Droid must recognize changes, build the APK itself, sign it, and then push the update to users.
9497
4. Build a debug APK yourself. This is the fastest way to get new features on your device, but is much more complicated, so we recommend using one of the other methods.
98+
5. If you're interested in a specific feature or bugfix provided in a Pull Request in this repo, you can also download its APK from within the PR. Read the PR description for instructions. The great thing about PR-specific APKs is that they're installed side-by-side the official app, so you don't have to worry about losing your data or messing anything up.
9599

96-
We recommend method 1 for most users. APKs installed using method 1 or 2 are compatible with each other, but not with those installed using method 3. This is due to the same signing key (ours) being used for 1 and 2, but a different signing key (F-Droid's) being used for 3. Building a debug APK using method 4 excludes a key entirely. Signing keys help ensure that a user isn't tricked into installing a malicious update to an app.
100+
We recommend method 1 for most users. APKs installed using method 1 or 2 are compatible with each other (meaning that if you installed NewPipe using either method 1 or 2, you can also update NewPipe using the other), but not with those installed using method 3. This is due to the same signing key (ours) being used for 1 and 2, but a different signing key (F-Droid's) being used for 3. Building a debug APK using method 4 excludes a key entirely. Signing keys help ensure that a user isn't tricked into installing a malicious update to an app. When using method 5, each APK is signed with a different random key supplied by GitHub Actions, so you cannot even update it. You will have to backup and restore the app data each time you wish to use a new APK.
97101

98102
In the meanwhile, if you want to switch sources for some reason (e.g. NewPipe's core functionality breaks and F-Droid doesn't have the latest update yet), we recommend following this procedure:
99103
1. Back up your data via Settings > Content > Export Database so you keep your history, subscriptions, and playlists
100104
2. Uninstall NewPipe
101105
3. Download the APK from the new source and install it
102106
4. Import the data from step 1 via Settings > Content > Import Database
103107

104-
## Contribution
105-
Whether you have ideas, translations, design changes, code cleaning, or real heavy code changes, help is always welcome.
106-
The more is done the better it gets!
108+
<b>Note: when you're importing a database into the official app, always make sure that it is the one you exported _from_ the official app. If you import a database exported from an APK other than the official app, it may break things. Such an action is unsupported, and you should only do so when you're absolutely certain you know what you're doing.</b>
107109

108-
If you'd like to get involved, check our [contribution notes](.github/CONTRIBUTING.md).
110+
## Contribution
111+
Whether you have ideas, translations, design changes, code cleaning, or even major code changes, help is always welcome. The app gets better and better with each contribution, no matter how big or small! If you'd like to get involved, check our [contribution notes](.github/CONTRIBUTING.md).
109112

110113
<a href="https://hosted.weblate.org/engage/newpipe/">
111114
<img src="https://hosted.weblate.org/widgets/newpipe/-/287x66-grey.png" alt="Translation status" />
112115
</a>
113116

114117
## Donate
115-
If you like NewPipe we'd be happy about a donation. You can either send bitcoin or donate via Bountysource or Liberapay. For further info on donating to NewPipe, please visit our [website](https://newpipe.net/donate).
118+
If you like NewPipe, you're welcome to send a donation. We prefer Liberapay, as it is both open-source and non-profit. For further info on donating to NewPipe, please visit our [website](https://newpipe.net/donate).
116119

117120
<table>
118-
<tr>
119-
<td><img src="https://bitcoin.org/img/icons/logotop.svg" alt="Bitcoin"></td>
120-
<td><img src="assets/bitcoin_qr_code.png" alt="Bitcoin QR code" width="100px"></td>
121-
<td><samp>16A9J59ahMRqkLSZjhYj33n9j3fMztFxnh</samp></td>
122-
</tr>
123121
<tr>
124122
<td><a href="https://liberapay.com/TeamNewPipe/"><img src="https://upload.wikimedia.org/wikipedia/commons/2/27/Liberapay_logo_v2_white-on-yellow.svg" alt="Liberapay" width="80px" ></a></td>
125123
<td><a href="https://liberapay.com/TeamNewPipe/"><img src="assets/liberapay_qr_code.png" alt="Visit NewPipe at liberapay.com" width="100px"></a></td>
126124
<td><a href="https://liberapay.com/TeamNewPipe/donate"><img src="assets/liberapay_donate_button.svg" alt="Donate via Liberapay" height="35px"></a></td>
127125
</tr>
126+
<tr>
127+
<td><img src="https://bitcoin.org/img/icons/logotop.svg" alt="Bitcoin"></td>
128+
<td><img src="assets/bitcoin_qr_code.png" alt="Bitcoin QR code" width="100px"></td>
129+
<td><samp>16A9J59ahMRqkLSZjhYj33n9j3fMztFxnh</samp></td>
130+
</tr>
128131
<tr>
129132
<td><a href="https://www.bountysource.com/teams/newpipe"><img src="https://upload.wikimedia.org/wikipedia/commons/thumb/2/22/Bountysource.png/320px-Bountysource.png" alt="Bountysource" width="190px"></a></td>
130133
<td><a href="https://www.bountysource.com/teams/newpipe"><img src="assets/bountysource_qr_code.png" alt="Visit NewPipe at bountysource.com" width="100px"></a></td>
@@ -134,14 +137,9 @@ If you like NewPipe we'd be happy about a donation. You can either send bitcoin
134137

135138
## Privacy Policy
136139

137-
The NewPipe project aims to provide a private, anonymous experience for using media web services.
138-
Therefore, the app does not collect any data without your consent. NewPipe's privacy policy explains in detail what data is sent and stored when you send a crash report, or comment in our blog. You can find the document [here](https://newpipe.net/legal/privacy/).
140+
The NewPipe project aims to provide a private, anonymous experience for using web-based media services. Therefore, the app does not collect any data without your consent. NewPipe's privacy policy explains in detail what data is sent and stored when you send a crash report, or leave a comment in our blog. You can find the document [here](https://newpipe.net/legal/privacy/).
139141

140142
## License
141143
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](https://www.gnu.org/licenses/gpl-3.0.en.html)
142144

143-
NewPipe is Free Software: You can use, study, share, and improve it at
144-
will. Specifically you can redistribute and/or modify it under the terms of the
145-
[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as
146-
published by the Free Software Foundation, either version 3 of the License, or
147-
(at your option) any later version.
145+
NewPipe is Free Software: You can use, study, share, and improve it at will. Specifically you can redistribute and/or modify it under the terms of the [GNU General Public License](https://www.gnu.org/licenses/gpl.html) as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

0 commit comments

Comments
 (0)