aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMiguel Ángel Moreno <mail@migalmoreno.com>2022-12-31 13:16:30 +0100
committerMiguel Ángel Moreno <mail@migalmoreno.com>2022-12-31 13:27:34 +0100
commit072d02e45d6a682857dd69751a06ef40b2e80d00 (patch)
tree7ef1761b7a3b8c5b36d9fca17b748c410497af91 /README
parent916ba00f83685e582c564232f2439770bf8131e6 (diff)
chore(docs): Add contribution links
Diffstat (limited to 'README')
-rw-r--r--README6
1 files changed, 4 insertions, 2 deletions
diff --git a/README b/README
index 6b12848..d920456 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 for various streaming sites. 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.
+A front-end alternative to various streaming sites. 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 run the application, first compile the downloader ahead-of-time.
@@ -28,4 +28,6 @@ You can now start a local server that listens on port 3000 by running the follow
clojure -M:run
#+end_src
-Access the front-end in your browser at =https://localhost:3000=.
+Access the front-end in your browser at =http://localhost:3000=.
+
+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]].