Merge pull request #945 from Materialious/update/readme
Update README.md
This commit is contained in:
Ward
GitHub
@@ -1,9 +1,4 @@
|
||||
|
||||
> [!WARNING]
|
||||
> Invidious is currently being blocked by Google. Please use Materialious on [Android](https://github.com/Materialious/Materialious/releases/latest) or [Desktop](https://github.com/Materialious/Materialious/releases/latest) to get around this with local video fallback.
|
||||
|
||||
<div align="center">
|
||||
<img src="./materialious/static/logo.svg" width="200px" />
|
||||
<div align="center"> <img src="./materialious/static/logo.svg" width="200px" />
|
||||
<br />
|
||||
<br />
|
||||
<h1>Materialious</h1>
|
||||
@@ -21,15 +16,14 @@
|
||||
|
||||
|
||||
# Features
|
||||
- [Invidious companion support.](./docs/DOCKER.md#invidious-companion-support)
|
||||
- [Invidious API extended integration!](https://github.com/Materialious/api-extended)
|
||||
- Sync your watch progress between Invidious sessions.
|
||||
- Watch sync parties!
|
||||
- [YouTube.js](https://github.com/LuanRT/YouTube.js) fallback if Invidious fails loading videos for Desktop & Android.
|
||||
- Preview video on hover.
|
||||
- Sync your watch progress between Invidious sessions.
|
||||
- Watch sync parties!
|
||||
- Sponsorblock built-in.
|
||||
- Return YouTube dislikes built-in.
|
||||
- DeArrow built-in (With local processing fallback).
|
||||
- Video progress tracking & resuming.
|
||||
- No ads.
|
||||
- No tracking.
|
||||
- Light/Dark themes.
|
||||
@@ -44,29 +38,16 @@
|
||||
- YT path redirects (So your redirect plugins should still work!)
|
||||
|
||||
# Support table
|
||||
| | Dash | HLS | Local video fallback | API-Extended | Dearrow | RYD |
|
||||
|---------|------|-----|----------------------|--------------|---------|-----|
|
||||
| Web | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ |
|
||||
| Desktop | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
| Android | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
|
||||
|
||||
# Public instances
|
||||
[Public instances are listed here](./docs/INSTANCES.md).
|
||||
|
||||
Open an issue to add your instance.
|
||||
|
||||
# Translations
|
||||
|
||||
Help [translate Materialious via Weblate](https://toolate.othing.xyz/projects/materialious/)!
|
||||
|
||||
<a href="https://toolate.othing.xyz/projects/materialious/">
|
||||
<img src="https://toolate.othing.xyz/widget/materialious/materialious/multi-auto.svg" alt="Translation status" />
|
||||
</a>
|
||||
| | Dash | HLS | Local video fallback | API-Extended | Dearrow | RYD | Watch Parties |
|
||||
|---------|------|-----|----------------------|--------------|---------|-----|----------------|
|
||||
| Web | ✅ | ✅ | ❌ | ✅ | ✅ | ✅ | ✅ |
|
||||
| Desktop | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
|
||||
| Android | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
|
||||
|
||||
# Deploying as a website via docker
|
||||
[Please read the guide here](./docs/DOCKER.md)
|
||||
|
||||
# Installing as a local application
|
||||
# Installing as a app
|
||||
<!--This layout is taken from spotube's README as I really liked its layout.
|
||||
I've commented out places what aren't relevant but might be in the future.-->
|
||||
<table>
|
||||
@@ -208,6 +189,14 @@ brew install --cask spotube
|
||||
</tr> -->
|
||||
</table>
|
||||
|
||||
# Translations
|
||||
|
||||
Help [translate Materialious via Weblate](https://toolate.othing.xyz/projects/materialious/)!
|
||||
|
||||
<a href="https://toolate.othing.xyz/projects/materialious/">
|
||||
<img src="https://toolate.othing.xyz/widget/materialious/materialious/multi-auto.svg" alt="Translation status" />
|
||||
</a>
|
||||
|
||||
# Previews
|
||||
|
||||
## Mobile
|
||||
|
||||
+7
-5
@@ -1,6 +1,3 @@
|
||||
## Work in Progress
|
||||
This documentation is currently under development and subject to updates.
|
||||
|
||||
## Building
|
||||
### Web Deployment (via Docker)
|
||||
Materialious supports web deployment through Docker.
|
||||
@@ -18,8 +15,13 @@ Materialious desktop builds are handled through GitHub using [prod-desktop.yml](
|
||||
- The [patch_capacitor_plugin.py](../materialious/electron/patch_capacitor_plugin.py) script removes the [Capacitor-NodeJS](https://github.com/hampoelz/Capacitor-NodeJS) plugin from the desktop build, as it's not required and currently has no better alternative.
|
||||
- From here, the process follows standard [electron-builder](https://www.electron.build/) steps to complete the build.
|
||||
|
||||
### Desktop Release (via Flatpak)
|
||||
TODO
|
||||
### Desktop Release (via Flathub)
|
||||
- After all workflows have completed, the [prod-flatpak](https://github.com/Materialious/Materialious/blob/update/readme/.github/workflows/prod-flathub.yml) workflow runs.
|
||||
- It downloads the AMD and ARM packages from the latest release.
|
||||
- It computes SHA-256 hashes for both packages.
|
||||
- It inserts the hashes into the Flatpak manifest.
|
||||
- It automatically opens a pull request on our [Flathub repository](https://github.com/flathub/us.materialio.Materialious).
|
||||
|
||||
|
||||
### Android Release
|
||||
Android builds are handled using the workflow [prod-android.yml](../.github/workflows/prod-android.yml).
|
||||
|
||||
+2
-54
@@ -12,19 +12,16 @@ Materialious allows you to customize various settings by overwriting the default
|
||||
+ [Amoled](#color)
|
||||
* [Interface](#interface)
|
||||
+ [Search suggestions](#search-suggestions)
|
||||
+ [Preview video on hover](#preview-video-on-hover)
|
||||
+ [Region](#region)
|
||||
+ [Letter case for titles](#letter-case-for-titles)
|
||||
+ [Auto expand comments](#auto-expand-comments)
|
||||
+ [Auto expand description](#auto-expand-desc)
|
||||
+ [Low bandwidth mode](#low-bandwidth-mode)
|
||||
+ [Display thumbnail avatars](#)
|
||||
* [Player](#player)
|
||||
+ [Autoplay video](#autoplay-video)
|
||||
+ [Always loop video](#always-loop-video)
|
||||
+ [Proxy videos](#proxy-videos)
|
||||
+ [Save playback position](#save-playback-position)
|
||||
+ [Listen by default](#listen-by-default)
|
||||
+ [Theatre mode by default](#theatre-mode-by-default)
|
||||
+ [Autoplay next by default](#autoplay-next-by-default)
|
||||
+ [Default video quality](#default-video-quality)
|
||||
@@ -89,13 +86,6 @@ Enables or disables search suggestions.
|
||||
"searchSuggestions": true
|
||||
```
|
||||
|
||||
### Preview video on hover
|
||||
|
||||
Allows video previews when hovering over thumbnails.
|
||||
|
||||
```json
|
||||
"previewVideoOnHover": true
|
||||
```
|
||||
|
||||
### Region
|
||||
|
||||
@@ -137,16 +127,7 @@ Avoids loading images.
|
||||
"lowBandwidthMode": true
|
||||
```
|
||||
|
||||
### Enable thumbnail avatars
|
||||
```json
|
||||
"displayThumbnailAvatars": true
|
||||
```
|
||||
|
||||
## Player
|
||||
|
||||
### Default video quality
|
||||
|
||||
Determines the default quality for videos.
|
||||
### Default quality for videos.
|
||||
|
||||
```json
|
||||
"defaultQuality": "1440"
|
||||
@@ -184,40 +165,7 @@ Saves the playback position of videos.
|
||||
"savePlaybackPosition": true
|
||||
```
|
||||
|
||||
### Listen by default
|
||||
|
||||
Enables or disables listening by default.
|
||||
|
||||
```json
|
||||
"listenByDefault": true
|
||||
```
|
||||
|
||||
### Theatre mode by default
|
||||
|
||||
Controls whether theatre mode is enabled by default.
|
||||
|
||||
```json
|
||||
"theatreModeByDefault": false
|
||||
```
|
||||
|
||||
### Autoplay next by default
|
||||
|
||||
Determines if the next video should autoplay.
|
||||
|
||||
```json
|
||||
"autoplayNextByDefault": false
|
||||
```
|
||||
|
||||
### Dash
|
||||
|
||||
Enables DASH streaming for higher resolutions.
|
||||
|
||||
```json
|
||||
"dashEnabled": true
|
||||
```
|
||||
|
||||
## Return YT Dislikes
|
||||
|
||||
### Return YT Dislikes
|
||||
Configures an open-source proxy for the Return YouTube Dislike API, with optional self-hosting.
|
||||
|
||||
```json
|
||||
|
||||
Reference in New Issue
Block a user