Browse Source

docs: document features, public instances, and extension support

Miguel Ángel Moreno 7 months ago
parent
commit
ce29c6df28
1 changed files with 23 additions and 0 deletions
  1. 23 0
      README

+ 23 - 0
README

@@ -3,6 +3,13 @@
 * Tubo
 * Tubo
 Tubo is a streaming front-end focused on bringing the [[https://newpipe.net/][NewPipe]] experience to the web. It aims at providing a clean and simple user interface to consume media from your favorite streaming platforms. It currently supports the same services as NewPipe, including YouTube, SoundCloud, Bandcamp, and more.
 Tubo is a streaming front-end focused on bringing the [[https://newpipe.net/][NewPipe]] experience to the web. It aims at providing a clean and simple user interface to consume media from your favorite streaming platforms. It currently supports the same services as NewPipe, including YouTube, SoundCloud, Bandcamp, and more.
 
 
+** Features
+- No ads
+- Background player
+- Playback queue
+- User playlists
+- System/Light/Dark themes
+
 ** Installation
 ** Installation
 *** Packaging
 *** Packaging
 **** Uberjar
 **** Uberjar
@@ -54,6 +61,13 @@ server {
 }
 }
 #+end_src
 #+end_src
 
 
+** Public Instances
+| URL                           | Country |
+|-------------------------------+---------|
+| https://tubo.media (Official) | 🇪🇸    |
+| https://tubo.reallyaweso.me   | 🇩🇪    |
+| https://tubo.ducks.party      | 🇩🇪    |
+
 ** Browser Extension Support
 ** Browser Extension Support
 *** [[https://einaregilsson.com/redirector/][Redirector]]
 *** [[https://einaregilsson.com/redirector/][Redirector]]
 You can manually add any redirect rule based on regex patterns with this extension. Below are some sample configurations to redirect links from supported services to Tubo so you get a basic idea of how to write manual Redirector rules. Note the =serviceId= of each service is: YouTube (0), SoundCloud(1), media.ccc.de(2), PeerTube(3), and Bandcamp(4).
 You can manually add any redirect rule based on regex patterns with this extension. Below are some sample configurations to redirect links from supported services to Tubo so you get a basic idea of how to write manual Redirector rules. Note the =serviceId= of each service is: YouTube (0), SoundCloud(1), media.ccc.de(2), PeerTube(3), and Bandcamp(4).
@@ -110,3 +124,12 @@ Example result: https://<TUBO_HOST>/search?query=37c3&serviceId=2
 Pattern type: Regular Expression
 Pattern type: Regular Expression
 Apply to: Main window (address bar)
 Apply to: Main window (address bar)
 #+end_src
 #+end_src
+
+*** [[https://libredirect.github.io/][LibRedirect]]
+Redirects many popular services to their alternative front-ends. Has a ton of features and an active community. Tubo is supported by default for YouTube and SoundCloud.
+
+*** [[https://github.com/libreom/predirect][Predirect]]
+Serves the same purpose as LibRedirect but is Manifest V3 compatible. Tubo is supported by default for SoundCloud.
+
+*** [[https://github.com/dybdeskarphet/privacy-redirector][Privacy Redirector]]
+A user-script that redirects popular social media platforms to their privacy respecting front-ends. Tubo is supported by default for YouTube and SoundCloud.