Browse Source

chore: update docs

Miguel Ángel Moreno 1 year ago
parent
commit
9db6546104
2 changed files with 25 additions and 19 deletions
  1. 11 8
      README
  2. 14 11
      README.md

+ 11 - 8
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]]

+ 14 - 11
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)