aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorTim Keller <tjk@tjkeller.xyz>2026-05-14 17:40:36 -0500
committerTim Keller <tjk@tjkeller.xyz>2026-05-14 17:40:36 -0500
commitafca82bbf549ac0bb0af39ee4152ac06b31acaaa (patch)
treea9ad3d49e97f5cd3afa8186b21dd76893f0ca64d /README.md
parent3b246c066f00a8820231d25519109e77d35edd23 (diff)
downloadembedtube-afca82bbf549ac0bb0af39ee4152ac06b31acaaa.tar.xz
embedtube-afca82bbf549ac0bb0af39ee4152ac06b31acaaa.zip
rename project to embedtube and revise readme.md. add btc donation link
Diffstat (limited to 'README.md')
-rw-r--r--README.md42
1 files changed, 36 insertions, 6 deletions
diff --git a/README.md b/README.md
index 4775fb3..210735a 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,37 @@
-# MINTUBE
-A Minimal YouTube client utilizing embeds and the official YouTube API.
+# EMBEDTUBE
+A tiny, distraction-free YouTube web-client using the official [embed API](https://developers.google.com/youtube/iframe_api_reference).
+Written in [Go](https://go.dev/)
-# API KEY
-The API key is required for video details and comments.
-Generate an API key and either `export` it into your environment using
-`API_KEY=...` or, better yet, save it into a `.env` file.
+# USAGE
+Simply replace the hostname of your youtube.com or youtu.be link with the hostname of your favorite EmbedTube instance:
+
+E.g. https://www.youtube.com/watch?v=cvDyQUpaFf4
+: => https://embedtube.tjkeller.xyz/watch?v=cvDyQUpaFf4
+
+E.g. https://youtu.be/cvDyQUpaFf4?t=75
+: => https://embedtube.tjkeller.xyz/cvDyQUpaFf4?t=75
+
+# SELF-HOSTING
+Install [Go](https://go.dev/) and [Git](https://git-scm.com/). Then run:
+```sh
+git clone https://git.tjkeller.xyz/embedtube
+cd embedtube
+go run .
+```
+
+## API KEY
+EmbedTube currently uses the official YouTube API for grabbing video details and comments.
+Generate an API key and export it into your environment using `API_KEY=`.
+Or better yet, save it into a `.env` file!
+
+# DONATE
+BTC: [bc1q2ehdum4d3y0grwtcpqcf33kpljusl6c0urdsvqmy6zvkaydgh8hsr0m2t0](bitcoin:bc1q2ehdum4d3y0grwtcpqcf33kpljusl6c0urdsvqmy6zvkaydgh8hsr0m2t0) ([QR](/static/btc-qr.png))
+
+# COPYRIGHT
+EmbedTube is [Free Software](https://www.gnu.org/philosophy/free-sw.en.html).
+It is made available under the [MIT license](https://git.tjkeller.xyz/embedtube/plain/LICENSE).
+
+You can clone or view the git repository here:
+: https://git.tjkeller.xyz/embedtube
+
+Copyright (c) 2026 Tim Keller <https://tjkeller.xyz>