aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiguel Ángel Moreno <mail@migalmoreno.com>2023-10-22 20:49:35 +0200
committerMiguel Ángel Moreno <mail@migalmoreno.com>2023-10-22 22:43:32 +0200
commit9db654610449d2c6c50f09d16f4ffcd9c60741cd (patch)
treeba4d67c2eb5881a08ea55261f4b71b202095747e
parent60107f3a5d9283de7914c61b93d1fe985ed8afdd (diff)
chore: update docs
-rw-r--r--README19
-rw-r--r--README.md25
2 files changed, 25 insertions, 19 deletions
diff --git a/README b/README
index 54358d4..770b6f6 100644
--- a/README
+++ b/README
@@ -1,9 +1,18 @@
# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; after-save-hook: org-md-export-to-markdown; -*-
#+OPTIONS: toc:nil num:nil
* Tubo
-Tubo is a streaming front-end focused on bringing the [[https://github.com/TeamNewPipe/NewPipe][NewPipe]] experience to the web. It currently supports the same platforms as NewPipe, including YouTube, SoundCloud, and more.
+Tubo is a streaming front-end focused on bringing the [[https://github.com/TeamNewPipe/NewPipe][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.
-To retrieve the data, it wraps the excellent [[https://github.com/TeamNewPipe/NewPipeExtractor][NewPipe Extractor]] library and exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
+To retrieve the data, it wraps the excellent [[https://github.com/TeamNewPipe/NewPipeExtractor][NewPipe Extractor]] library and it exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
+
+** Features
+- [X] No ads
+- [X] Audio player
+- [X] Media queue
+- [ ] Playlists
+- [X] Local settings
+- [ ] Local subscriptions
+- [ ] User management
** Instances
| URL | Country |
@@ -91,12 +100,6 @@ server {
}
#+end_src
-** Road-map
-- [X] Basic audio player
-- [ ] Track queuing system
-- [ ] Playlists
-- [ ] User settings
-
** Screenshots
[[https://files.migalmoreno.com/tubo_kiosk.jpg]]
[[https://files.migalmoreno.com/tubo_channel.jpg]]
diff --git a/README.md b/README.md
index e3082cc..d230de5 100644
--- a/README.md
+++ b/README.md
@@ -2,9 +2,20 @@
# Tubo
-Tubo is a streaming front-end focused on bringing the [NewPipe](https://github.com/TeamNewPipe/NewPipe) experience to the web. It currently supports the same platforms as NewPipe, including YouTube, SoundCloud, and more.
+Tubo is a streaming front-end focused on bringing the [NewPipe](https://github.com/TeamNewPipe/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.
-To retrieve the data, it wraps the excellent [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor) library and exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
+To retrieve the data, it wraps the excellent [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor) library and it exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
+
+
+## Features
+
+- [X] No ads
+- [X] Audio player
+- [X] Media queue
+- [ ] Playlists
+- [X] Local settings
+- [ ] Local subscriptions
+- [ ] User management
## Instances
@@ -32,7 +43,7 @@ To retrieve the data, it wraps the excellent [NewPipe Extractor](https://github.
</tbody>
</table>
-If you consider self-hosting Tubo let me know about your instance via the [contribution methods](#orgd4254ad). See [installation](#orgb8016f7) for ways to set up Tubo in your server.
+If you consider self-hosting Tubo let me know about your instance via the [contribution methods](#org6588695). See [installation](#org4704244) for ways to set up Tubo in your server.
## Installation
@@ -105,14 +116,6 @@ If you want to self-host Tubo and make it publicly accessible you'll need to set
}
-## Road-map
-
-- [X] Basic audio player
-- [ ] Track queuing system
-- [ ] Playlists
-- [ ] User settings
-
-
## Screenshots
![img](https://files.migalmoreno.com/tubo_kiosk.jpg)