aboutsummaryrefslogtreecommitdiff
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
parent3b246c066f00a8820231d25519109e77d35edd23 (diff)
downloadembedtube-afca82bbf549ac0bb0af39ee4152ac06b31acaaa.tar.xz
embedtube-afca82bbf549ac0bb0af39ee4152ac06b31acaaa.zip
rename project to embedtube and revise readme.md. add btc donation link
-rw-r--r--Dockerfile6
-rw-r--r--README.md42
-rw-r--r--docker-compose.yaml2
-rw-r--r--go.mod2
-rw-r--r--static/btc-qr.pngbin0 -> 1900 bytes
-rw-r--r--templates/base.html1
6 files changed, 42 insertions, 11 deletions
diff --git a/Dockerfile b/Dockerfile
index ce83df8..df2de42 100644
--- a/Dockerfile
+++ b/Dockerfile
@@ -11,13 +11,13 @@ RUN go mod download
COPY . .
# Build the Go app
-RUN go build -o mintube .
+RUN go build -o embedtube .
# Final lightweight image
FROM alpine:latest
WORKDIR /app
-COPY --from=builder /app/mintube .
+COPY --from=builder /app/embedtube .
COPY --from=builder /app/README.md .
COPY --from=builder /app/templates ./templates
COPY --from=builder /app/static ./static
@@ -26,4 +26,4 @@ COPY --from=builder /app/static ./static
EXPOSE 8080
# Run the Go app
-CMD ["./mintube"]
+CMD ["./embedtube"]
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>
diff --git a/docker-compose.yaml b/docker-compose.yaml
index 3ad6b28..99f65b5 100644
--- a/docker-compose.yaml
+++ b/docker-compose.yaml
@@ -1,5 +1,5 @@
services:
- mintube:
+ embedtube:
build: .
restart: always
ports:
diff --git a/go.mod b/go.mod
index c2c4797..20aa1a3 100644
--- a/go.mod
+++ b/go.mod
@@ -1,4 +1,4 @@
-module tjkeller.xyz/mintube
+module tjkeller.xyz/embedtube
go 1.23.7
diff --git a/static/btc-qr.png b/static/btc-qr.png
new file mode 100644
index 0000000..680463d
--- /dev/null
+++ b/static/btc-qr.png
Binary files differ
diff --git a/templates/base.html b/templates/base.html
index 7c1f8eb..03ae355 100644
--- a/templates/base.html
+++ b/templates/base.html
@@ -1,6 +1,7 @@
<!DOCTYPE html>
<html lang="en">
<head>
+ <title>EmbedTube</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<link rel="stylesheet" href="/static/style.css">