Skip to content

Commit

Permalink
Readme updates for companion plugin
Browse files Browse the repository at this point in the history
  • Loading branch information
damontecres committed Aug 2, 2024
1 parent ac164c5 commit 6cd2490
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
7 changes: 4 additions & 3 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@ body:
attributes:
label: "App Version"
description: What version of the app?
placeholder: "v0.2.11"
placeholder: "v0.3.0"
validations:
required: true
- type: input
id: server
attributes:
label: "Server Version"
description: What version of the server?
placeholder: "v0.25.1"
placeholder: "v0.26.2"
validations:
required: true
- type: input
Expand All @@ -51,7 +51,8 @@ body:
id: logs
attributes:
label: "Logs"
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
description: Please [gather any logs or crash reports](https://github.com/damontecres/StashAppAndroidTV/wiki/Gathering-app-logs) and include them here.
placeholder: Review logs for personal information before sharing them here publicly!
render: bash
validations:
required: false
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ Check the [Tips & Tricks](https://github.com/damontecres/StashAppAndroidTV/wiki/
- Use `Send files to TV` from the Google Play Store on your phone & TV
- (Expert) Use [ADB](https://developer.android.com/studio/command-line/adb) to install the APK from your computer ([guide](https://fossbytes.com/side-load-apps-android-tv/#h-how-to-sideload-apps-on-your-android-tv-using-adb))
1. [Configure the app](#configuration)
1. Optionally, install the [StashAppAndroidTV Companion](https://github.com/damontecres/StashAppAndroidTV-Companion) plugin on your server to enable additional features
- Search for `StashAppAndroidTV Companion` on your server's Settings->Plugins page

### Upgrading the app

Expand Down Expand Up @@ -72,6 +74,12 @@ The app supports many devices running Android TV OS, such as the NVIDIA Shield,

See [Device Compatibility](https://github.com/damontecres/StashAppAndroidTV/wiki/Device-Compatibility) for more information.

## Companion plugin

The [StashAppAndroidTV Companion](https://github.com/damontecres/StashAppAndroidTV-Companion) plugin enables additional features in the app. It is not required to use the app, but it is recommended especially if you run into issues.

Currently, the plugin only supports receiving crash reports and logs from the app. But, this can help diagnose issues and improve the app.

## Contributions

Issues and pull requests are always welcome! UI/UX improvements are especially desired!
Expand Down

0 comments on commit 6cd2490

Please sign in to comment.