Add build badge + rework readme
This commit is contained in:
Charles Ewert
parent
a28783700b
commit
fce09e83ee
|
|
@ -27,7 +27,7 @@ Follow the steps below to install the app on your personal Roku device. This wil
|
|||
|
||||
## Developer Mode
|
||||
|
||||
Put your Roku device in [developer mode](https://blog.roku.com/developer/2016/02/04/developer-setup-guide). Write down your Roku device IP and the password you created, you will need these later.
|
||||
Put your Roku device in [developer mode](https://blog.roku.com/developer/2016/02/04/developer-setup-guide). Write down your Roku device IP and the password you created - you will need these!
|
||||
|
||||
## Clone the GitHub Repo
|
||||
|
||||
|
|
|
|||
63
README.md
63
README.md
|
|
@ -1,39 +1,42 @@
|
|||
<h1 style="text-align: center;">Jellyfin app for Roku</h1>
|
||||
<h3 style="text-align: center;">Part of the <a href="https://jellyfin.media/">Jellyfin</a> Project</h3>
|
||||
|
||||
<p align="center">
|
||||
<img alt="Logo banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/>
|
||||
<br/><br/>
|
||||
<a href="https://github.com/jellyfin/jellyfin-roku">
|
||||
<img alt="GPL 2.0 License" src="https://img.shields.io/github/license/jellyfin/jellyfin-roku.svg"/>
|
||||
</a>
|
||||
<a href="https://github.com/jellyfin/jellyfin-roku/releases">
|
||||
<img alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin-roku.svg"/>
|
||||
</a>
|
||||
<a href="https://translate.jellyfin.org/projects/jellyfin/jellyfin-roku/?utm_source=widget">
|
||||
<img src="https://translate.jellyfin.org/widgets/jellyfin/-/jellyfin-roku/svg-badge.svg" alt="Translation status" />
|
||||
</a>
|
||||
<br/>
|
||||
<a href="https://matrix.to/#/#jellyfin-dev-roku:matrix.org">
|
||||
<img alt="Chat on Matrix" src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"/>
|
||||
</a>
|
||||
<a href="https://www.reddit.com/r/jellyfin">
|
||||
<img alt="Join our Subreddit" src="https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg"/>
|
||||
</a>
|
||||
</p>
|
||||
<h1 style="text-align: center;">Jellyfin Roku</h1>
|
||||
<h2 style="text-align: center;">Part of the <a href="https://jellyfin.media">Jellyfin</a> Project</h2>
|
||||
|
||||
The Jellyfin Roku App is a Jellyfin client for Roku Devices. This is still very much a work in progress, so we would encourage you to [get involved](#get_involved) if you can.
|
||||
[](https://jellyfin.media)
|
||||
|
||||
## Getting Started
|
||||
[](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable)
|
||||
[](https://github.com/jellyfin/jellyfin-roku/releases)
|
||||
[](https://translate.jellyfin.org/projects/jellyfin/jellyfin-roku/?utm_source=widget)
|
||||
[](https://matrix.to/#/#jellyfin-dev-roku:matrix.org)
|
||||
[](https://www.reddit.com/r/jellyfin)
|
||||
[](LICENSE)
|
||||
|
||||
The channel is available on the [Roku Channel Store](https://channelstore.roku.com/details/cc5e559d08d9ec87c5f30dcebdeebc12/jellyfin).
|
||||
The Jellyfin Roku App is a Jellyfin client for Roku Devices and is still very much a work in progress. Please get involved if you can!
|
||||
|
||||
## Getting Involved<a name="get_involved"></a>
|
||||
## Install
|
||||
|
||||
No matter what your interests or skill are, you can help to make this client better for everyone by simply using the client and letting us know if you find a problem with it. Either give us a shout on [matrix](https://matrix.to/#/+jellyfin:matrix.org) or create a GitHub issue.
|
||||
Download the latest release on the [Roku Channel Store](https://channelstore.roku.com/details/cc5e559d08d9ec87c5f30dcebdeebc12/jellyfin).
|
||||
|
||||
Feature requests are always welcome too, but please have a read though the existing issues to see if someone has already raised one for something similar.
|
||||
## Get Involved
|
||||
|
||||
If you fancy some development, then read the [DEVGUIDE](DEVGUIDE.md) to find out the best ways to help.
|
||||
No matter what your interests or skills are you can help make this client better for everyone by simply using the client and giving feedback to the developers when things break. [Create an issue](https://github.com/jellyfin/jellyfin-roku/issues/new/choose) here on GitHub or give us a shout on [matrix](https://matrix.to/#/#jellyfin-dev-roku:matrix.org).
|
||||
|
||||
As Roku have severely limited their Beta channel program, the best way to test pre-release versions is by following the [DEVGUIDE](DEVGUIDE.md) to install and test the latest changes. Feedback is always welcome.
|
||||
## Feature Requests
|
||||
|
||||
New feature requests are always welcome but before creating an issue please read though the [existing issues](https://github.com/jellyfin/jellyfin-roku/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to see if someone has already raised one for what you're looking for.
|
||||
|
||||
## Beta Test
|
||||
|
||||
To test the latest features before they get released:
|
||||
|
||||
1. Put your Roku device in [developer mode](https://blog.roku.com/developer/2016/02/04/developer-setup-guide). Write down your Roku device IP and the password you created - you will need these!
|
||||
2. Download the [latest build](https://github.com/jellyfin/jellyfin-roku/actions/workflows/build-dev.yml?query=branch%3Aunstable) from the unstable branch
|
||||
3. Access your roku device by putting your Roku's IP from step 1 into a browser i.e. `http://192.168.1.2`
|
||||
4. Log in with credentials from step 1
|
||||
5. Upload and install the zip file downloaded in step 2
|
||||
|
||||
> NOTE: The beta app will always be at the bottom of your Roku's channel list and it will *not* automatically update.
|
||||
|
||||
## Advanced
|
||||
|
||||
For more advanced deployment methods, access to crashlogs, or to learn how to setup a developer environment to write some code yourself please see the [DEVGUIDE](DEVGUIDE.md)
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user