aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorTim Keller <tjk@tjkeller.xyz>2026-09-22 17:21:35 -0500
committerTim Keller <tjk@tjkeller.xyz>2026-09-22 17:21:35 -0500
commit72986a85304c0a85eec696658d6b9d0aefb0b1f8 (patch)
tree8fffdf0cbe2537cb74d33e6b078501dea75af54f /README.md
parente8f8e18e05210cd0ced19522b3fb06463e4645d0 (diff)
downloadembedtube-72986a85304c0a85eec696658d6b9d0aefb0b1f8.tar.xz
embedtube-72986a85304c0a85eec696658d6b9d0aefb0b1f8.zip
update readme to mention flake.nix and Dockerfile. change wording
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/README.md b/README.md
index cd99f39..d4eb7d4 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# EMBEDTUBE
-A tiny, distraction-free YouTube web-client using the official [embed API](https://developers.google.com/youtube/iframe_api_reference).
+A tiny, distraction-free YouTube micro-client which wraps the official [embed API](https://developers.google.com/youtube/iframe_api_reference).
Written in [Go](https://go.dev/)
# USAGE
@@ -19,6 +19,8 @@ cd embedtube
go run .
```
+A `flake.nix` with an option module and a `Dockerfile` are also available.
+
## 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=`.