Thorium-android-app/README.md

79 lines
3.5 KiB
Markdown

<h1 align="center">
Thorium, an Android PeerTube Client
</h1>
<p align="center">
<a href="https://github.com/sschueller/peertube-android/releases/latest" alt="GitHub release"><img src="https://img.shields.io/github/release/sschueller/peertube-android.svg" ></a>
<a href="https://www.gnu.org/licenses/agpl-3.0" alt="License: AGPLv3"><img src="https://img.shields.io/badge/License-AGPL%20v3-blue.svg"></a>
<a href="https://f-droid.org/de/packages/net.schueller.peertube/" alt="F-Droid release"><img src="https://img.shields.io/f-droid/v/net.schueller.peertube.svg"></a>
<a href="https://hosted.weblate.org/projects/peertube/" alt="Translation Status"><img src="https://hosted.weblate.org/widgets/peertube/-/svg-badge.svg"></a>
<a href="https://www.bountysource.com/teams/peertube-android" alt="Bountysource bounties"><img src="https://img.shields.io/bountysource/team/peertube-android/activity.svg?colorB=cd201f"></a>
<a href="https://liberapay.com/sschueller/donate" alt="Donate Link"><img src="http://img.shields.io/liberapay/patrons/sschueller.svg?logo=liberapay"></a>
</p>
## Screenshots
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/1_en-US.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/1_en-US.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/2_en-US.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/2_en-US.png)
[<img src="fastlane/metadata/android/en-US/images/phoneScreenshots/3_en-US.png" width=160>](fastlane/metadata/android/en-US/images/phoneScreenshots/3_en-US.png)
## Description
PeerTube is a federated video streaming platform that is community-owned and ad-free, with no vendor lock-in. This client allows you to watch and browse videos on a server of your choice in the PeerTube network.
This client comes preconfigured with one PeerTube server managed by the application creator - not the PeerTube project itself, which lists more on http://instances.joinpeertube.org/ - to allow you to have a taste of what the client is capable of. Choose your server to tune your experience!
Please note this is app is in beta and is still missing a lot of features.
## Download
* Beta Test on Google Play: https://play.google.com/store/apps/details?id=net.schueller.peertube
* F-Droid: https://f-droid.org/packages/net.schueller.peertube/
## Releases
Release Tags are automatically built and deployed to the play store but not released to production right away.
To use the latest tagged release download it from github or fdroid (~1 day delay).
## Reproducible Builds
Reproducible builds currently does not work.
## Help Translate
* https://hosted.weblate.org/projects/peertube/
## Features
* Recent Videos
* Trending Videos
* Endless scrolling
* Pull to refresh
* Very Basic Torrent playback
* Change Server
* Search
* Themes / Dark mode
* Background playback
* NSFW Filter option
* Authentication / Login
* Like/dislike video
* Video speed selection
* Video quality selection
* Server selection
* Video overlay play and draggable video window
## Coming soon
* Video Playback via WebRTC
* Comment videos
* Report Videos
* User / Channel Overview Page
* Unit Tests
* Lots more...
## Contribution
Whether you have ideas, translations, design changes, code cleaning, or real heavy code changes, help is always welcome.
For your commits please follow: https://www.conventionalcommits.org
## Donate
<noscript><a href="https://liberapay.com/sschueller/donate"><img alt="Donate using Liberapay" src="https://liberapay.com/assets/widgets/donate.svg"></a></noscript>
Bitcoin: 1LoTXo728HzYTtyfbkaf5ewSRvu8ABTDPm