From 444e2f9e29ae9d27eb97aa5e40463e146f5e95b3 Mon Sep 17 00:00:00 2001 From: Damontecres <154766448+damontecres@users.noreply.github.com> Date: Thu, 29 Aug 2024 22:04:33 -0400 Subject: [PATCH] Readme updates --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 63e36e8a..fb4b46b0 100644 --- a/README.md +++ b/README.md @@ -35,15 +35,17 @@ Check the [Tips & Tricks](https://github.com/damontecres/StashAppAndroidTV/wiki/ ### Upgrading the app -Starting with `v0.2.2`, the app will automatically check for updates and, as an experimental feature, the update can be installed in settings. +After the initial install above, the app will automatically check for updates which can then be installed in settings. + +The first time you attempt an update, the Android TV OS should guide you through enabling the required additional permissions for the app to install updates. #### Develop build -This build has the latest features, but may be unstable or have bugs! +This build is the current work-in-progress. It has the latest features, but may be unstable or have bugs! You can install the latest development debug build from the [develop pre-release](https://github.com/damontecres/StashAppAndroidTV/releases/tag/develop) using the same methods as above. The short code is `505547` or URL: https://aftv.news/505547 -Starting with `v0.2.2`, you update in-app to the newest development build by changing the URL in `Settings->Advanced->Update URL` to https://api.github.com/repos/damontecres/StashAppAndroidTV/releases/tags/develop (replace `latest` with `tags/develop`). +You can also use the in-app updater for development builds by changing the URL in `Settings->Advanced->Update URL` to https://api.github.com/repos/damontecres/StashAppAndroidTV/releases/tags/develop (replace `latest` with `tags/develop`). ### Configuration @@ -51,15 +53,16 @@ The first time you open the app, follow the prompts to configure the app to conn 1. Enter the full URL of your Stash server (e.g. `http://192.168.1.122:9999`) - Don't use `localhost`; use the IP address or domain of your Stash server + - Don't forget to include the port which 9999 by default - If you have configured HTTPS/SSL/TLS, make sure to use `https://` instead of `http://` -1. If you have enabled authentication on your Stash server, enter the API Key +1. If you have enabled authentication on your Stash server, you will be prompted to enter the API Key 1. Use your phone to browse to your Stash server and copy the API Key from the Settings->Security page (e.g. http://192.168.1.122:9999/settings?tab=security) 1. Use your phone's [virtual remote control](https://support.google.com/chromecast/answer/11221499) to paste the API Key into the TV app 1. If you have trouble submitting the URL or API Key using the virtual remote control, [see some tips here](https://github.com/damontecres/StashAppAndroidTV/wiki/Tips-&-Tricks#i-cant-submit-the-server-url-when-using-a-remote-phone-app) #### Multiple servers -You can configure multiple servers in the app. To add, remove, or switch servers, use the `Manage Servers` option in the settings. +You can configure multiple servers in the app. To add, remove, or switch servers, use the `Manage Servers` option in the settings or click the Stash icon on the main page. ### Compatibility