From d02dce556202109e6780eaff5d747d9e1cef671d Mon Sep 17 00:00:00 2001 From: Keegan Given <32858528+gkeegan@users.noreply.github.com> Date: Mon, 21 Jan 2019 02:35:39 +0000 Subject: [PATCH] Add updating section to README This will help cull the number of "how to update?" Issues whenever we need to push out a fix, like how recently NewPipe got completely broken. This attempts to be an all-inclusive guide to updating NewPipe. If there are any (clean/official) links to additional info, please comment them and I will add it. Also let me know if this section should be relocated within the README. I figured it would be best to keep it up top, so people see it right away, and then don't make a new Issue. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 15ba3d04b..79fb18eb5 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,20 @@ WARNING: PUTTING NEWPIPE OR ANY FORK OF IT INTO GOOGLE PLAYSTORE VIOLATES THEIR TERMS OF CONDITIONS. +## Updates +When a change to the NewPipe code occurs (due to either adding features or bug fixing), eventually a release will occur. These are in the format x.xx.x . In order to get this new version, you can: + * 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. + * Download the APK from [releases](https://github.com/TeamNewPipe/NewPipe/releases) and install it. + * 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. + +When you install an APK from one of these options, it will be incompatible with an APK from one of the other options. This is due to different signing keys being used. Signing keys help ensure that a user isn't tricked into installing a malicious update to an app, and are independent. F-Droid and GitHub use different signing keys, and building an APK debug excludes a key. + +If you want to switch sources for some reason (e.g. NewPipe's core functionality was broken and F-Droid doesn't have the update yet), we recommend following this procedure: +1. Back up your data via "Settings>Content>Export Database" so you keep your history, subscriptions, and playlists +2. Uninstall NewPipe +3. Download the APK from the new source and install it +4. Import the data from step 1 via "Settings>Content>Import Database" + ## Screenshots [](fastlane/metadata/android/en-US/images/phoneScreenshots/shot_01.png)