aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMiguel Ángel Moreno <mail@migalmoreno.com>2023-01-09 15:34:12 +0100
committerMiguel Ángel Moreno <mail@migalmoreno.com>2023-01-09 16:10:11 +0100
commit5e995881dd0c431ae63b1a50c2d03e59962241f1 (patch)
tree01d6be409e1f8b74ad4d4f61653f248ebda9dfb1 /README
parentdb76decda2d9309d1ba2b4aca31871e809a0fd6d (diff)
chore: Reword README and remove assets
Diffstat (limited to 'README')
-rw-r--r--README16
1 files changed, 7 insertions, 9 deletions
diff --git a/README b/README
index 97d298b..8f38c0e 100644
--- a/README
+++ b/README
@@ -1,7 +1,7 @@
# -*- mode: org; org-html-head-include-default-style: nil; org-html-postamble: nil; -*-
#+OPTIONS: toc:nil
* Tau
-An alternative front-end to various streaming sites. The aim of Tau is to free you from the world of ad-ridden streaming sites full of vendor lock-ins and restrictions, by providing you with a minimal interface to enjoy your favorite content from these sites. It currently supports the following platforms:
+An alternative front-end to various streaming sites. The aim of Tau is to free you from the world of ad-ridden streaming sites full of vendor lock-ins by providing you with a minimal interface to enjoy your favorite content. It currently supports the following platforms:
- YouTube
- SoundCloud
@@ -9,7 +9,9 @@ An alternative front-end to various streaming sites. The aim of Tau is to free y
- PeerTube
- Bandcamp
-To retrieve the data, it leverages the excellent [[https://github.com/TeamNewPipe/NewPipeExtractor][NewPipe Extractor]] library that powers the popular [[https://github.com/TeamNewPipe/NewPipe][NewPipe]] Android app. Tau exposes the extracted data over a REST API that is consumed by a local re-frame SPA. I built Tau because I stopped using Android and wanted to replicate the Newpipe experience both on desktop and mobile GNU/Linux.
+To retrieve the data, it leverages the excellent [[https://github.com/TeamNewPipe/NewPipeExtractor][NewPipe Extractor]] library that powers the popular [[https://github.com/TeamNewPipe/NewPipe][NewPipe]] Android app. Tau exposes the extracted data over a REST API that is consumed by a local re-frame SPA.
+
+The ultimate goal behind Tau is to replicate the Newpipe experience on the web, so that it's accessible to those that don't use an Android device.
** Installation
The easiest way to set up Tau's dependencies is via the [[https://guix.gnu.org/][GNU Guix]] package manager. Simply invoke what follows:
@@ -47,13 +49,9 @@ clojure -M:run
Access the front-end in your browser at =http://localhost:3000=.
** Screenshots
-Tau aims to create a uniform interface between all the aforementioned services. Hence, as in Newpipe, many interface elements are shared.
-
-[[file:assets/kiosk.jpg]]
-[[file:assets/channel.jpg]]
-[[file:assets/stream.jpg]]
-[[file:assets/mobile_comments.jpg]]
-[[file:assets/mobile_nav.jpg]]
+https://raw.githubusercontent.com/efimerspan/tau/master/assets/kiosk.jpg
+https://raw.githubusercontent.com/efimerspan/tau/master/assets/channel.jpg
+https://raw.githubusercontent.com/efimerspan/tau/master/assets/stream.jpg
** Contributing
You can use the project's [[https://lists.sr.ht/~conses/tau][mailing list]] to send feedback, patches or open discussions. Bugs should be reported on the project's [[https://todo.sr.ht/~conses/tau][bug-tracker]].