commit 36c906625c313a714939936918a3f013431309ed
parent ab06d58c0a3b9a2d3bc13aa85d47079606b1b5a0
Author: JayVii <jayvii[AT]posteo[DOT]de>
Date: Sat, 29 Jun 2024 21:09:28 +0200
feat: transform readme to markdown
Diffstat:
2 files changed, 23 insertions(+), 22 deletions(-)
diff --git a/README b/README
@@ -1,22 +0,0 @@
-yt2html
-======
-
-Please send patches or remarks to <jayvii[AT]posteo[DOT]de>
-
-Fetches your YouTube "subscriptions" via RSS and provides all uploaded videos
-in a chronological order with infos about the Channel name, Video title,
-Upload date and the thumbnail.
-
-Thumbnails are directly embedded from YouTube (transfers the client's IP to
-Youtube). Upon clicking a thumbnail, embedds an iframe to youtube-nocookie.com
-in order to be able to watch the video right there.
-
-Videos are not(!) fetched periodically, but can be polled on-demand via the
-"reload" button. Fetching is done via an R-script ("yt.R").
-
-Subscriptions are added via the "url.csv" file, that includes AT LEAST one
-column names "url", which contains the YouTube RSS url to that channel.
-
-An example CSV file is included: "url.csv.sample", which you can use by doing:
-
- mv url.csv.sample url.csv
diff --git a/README.md b/README.md
@@ -0,0 +1,23 @@
+# yt2html
+
+Please send patches or remarks to <jayvii[AT]posteo[DOT]de>
+
+Fetches your YouTube "subscriptions" via RSS and provides all uploaded videos
+in a chronological order with infos about the Channel name, Video title,
+Upload date and the thumbnail.
+
+Thumbnails are directly embedded from YouTube (transfers the client's IP to
+Youtube). Upon clicking a thumbnail, embedds an iframe to youtube-nocookie.com
+in order to be able to watch the video right there.
+
+Videos are not(!) fetched periodically, but can be polled on-demand via the
+"reload" button. Fetching is done via an R-script ("yt.R").
+
+Subscriptions are added via the "url.csv" file, that includes AT LEAST one
+column names "url", which contains the YouTube RSS url to that channel.
+
+An example CSV file is included: "url.csv.sample", which you can use by doing:
+
+```bash
+mv url.csv.sample url.csv
+```
