From db76decda2d9309d1ba2b4aca31871e809a0fd6d Mon Sep 17 00:00:00 2001 From: Miguel Ángel Moreno Date: Thu, 5 Jan 2023 22:21:15 +0100 Subject: chore: Expand README and include assets --- README | 15 +++++++++++++-- assets/channel.jpg | Bin 0 -> 103102 bytes assets/kiosk.jpg | Bin 0 -> 178962 bytes assets/mobile_comments.jpg | Bin 0 -> 53610 bytes assets/mobile_nav.jpg | Bin 0 -> 20192 bytes assets/stream.jpg | Bin 0 -> 104960 bytes 6 files changed, 13 insertions(+), 2 deletions(-) create mode 100644 assets/channel.jpg create mode 100644 assets/kiosk.jpg create mode 100644 assets/mobile_comments.jpg create mode 100644 assets/mobile_nav.jpg create mode 100644 assets/stream.jpg diff --git a/README b/README index 241024a..97d298b 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 -A front-end alternative to various streaming 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 and restrictions, by providing you with a minimal interface to enjoy your favorite content from these sites. It currently supports the following platforms: - YouTube - SoundCloud @@ -9,8 +9,9 @@ A front-end alternative to various streaming sites. It currently supports the fo - 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. +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. +** 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: #+begin_src sh @@ -45,4 +46,14 @@ 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]] + +** 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]]. diff --git a/assets/channel.jpg b/assets/channel.jpg new file mode 100644 index 0000000..41c9d48 Binary files /dev/null and b/assets/channel.jpg differ diff --git a/assets/kiosk.jpg b/assets/kiosk.jpg new file mode 100644 index 0000000..2c00266 Binary files /dev/null and b/assets/kiosk.jpg differ diff --git a/assets/mobile_comments.jpg b/assets/mobile_comments.jpg new file mode 100644 index 0000000..d4028d3 Binary files /dev/null and b/assets/mobile_comments.jpg differ diff --git a/assets/mobile_nav.jpg b/assets/mobile_nav.jpg new file mode 100644 index 0000000..39d872b Binary files /dev/null and b/assets/mobile_nav.jpg differ diff --git a/assets/stream.jpg b/assets/stream.jpg new file mode 100644 index 0000000..25d0b18 Binary files /dev/null and b/assets/stream.jpg differ -- cgit v1.2.3