aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/README.md
diff options
context:
space:
mode:
authorgarret <garret@airmail.cc>2024-08-26 16:13:21 +0100
committergarret <garret@airmail.cc>2024-08-26 16:13:21 +0100
commit3cf478a58d81a37cc49a9055ba72582dd2d74365 (patch)
tree2b18e18becd065a669947b86dc5e5acd30c8da93 /README.md
parent2fda4016aa082da057d08627c10f3ec49475c8b9 (diff)
downloadyt-dlp-rajiko-3cf478a58d81a37cc49a9055ba72582dd2d74365.tar.gz
yt-dlp-rajiko-3cf478a58d81a37cc49a9055ba72582dd2d74365.tar.bz2
yt-dlp-rajiko-3cf478a58d81a37cc49a9055ba72582dd2d74365.zip
add useful information back to the readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md50
1 files changed, 46 insertions, 4 deletions
diff --git a/README.md b/README.md
index 1a59bfc..31b8601 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,54 @@
yt-dlp-rajiko is an improved [radiko.jp](https://radiko.jp) extractor plugin for yt-dlp.
-[Please see the website for more information, including installation and usage instructions](https://427738.xyz/yt-dlp-rajiko/).
+## Installation
-If the website is down, an archived copy may be available on [the Internet Archive's Wayback Machine](https://web.archive.org/web/*/https://427738.xyz/yt-dlp-rajiko/).
+[Download the Python wheel](https://427738.xyz/yt-dlp-rajiko/dl/yt_dlp_rajiko-latest.whl) or `pip install
+--extra-index-url https://427738.xyz/yt-dlp-rajiko/pip/ yt-dlp-rajiko`
+
+Requires yt-dlp 2023.06.22 or above.
+
+Use the pip command if you installed yt-dlp with pip. If you installed
+yt-dlp with `pipx`, use `pipx inject --index-url
+https://427738.xyz/yt-dlp-rajiko/pip/ yt-dlp yt-dlp-rajiko` to install
+the plugin in yt-dlp's environment.
+
+Otherwise, download the wheel, and place it in one of these locations:
+
+ - `~/.config/yt-dlp/plugins/` (on Linux and Mac)
+ - `%appdata%/yt-dlp/plugins/` (on Windows)
+ - anywhere else listed in [the yt-dlp
+ documentation](https://github.com/yt-dlp/yt-dlp#installing-plugins).
+
+You'll have to create those folders if they don't already exist.
More information about yt-dlp plugins is available from [yt-dlp's documentation](https://github.com/yt-dlp/yt-dlp#plugins).
-[詳しくは公式サイトをご覧ください](https://427738.xyz/yt-dlp-rajiko/index.ja.html)
+## Usage
+
+simply:
+
+ # timefree download
+ yt-dlp 'https://radiko.jp/#!/ts/INT/20240308230000'
+ # live recording
+ yt-dlp 'https://radiko.jp/#!/live/CCL'
+ # live shorthand
+ yt-dlp 'https://radiko.jp/#FMT'
+
+You can somewhat automate downloading programmes by using the search
+page.
+
+ # all programmes related to Toshiki Kadomatsu
+ yt-dlp 'https://radiko.jp/#!/search/live?key=角松敏生&filter=past&region_id=all'
+ # specific programme from Osaka
+ yt-dlp 'https://radiko.jp/#!/search/live?key=world%20jazz%20warehouse&filter=past&area_id=JP27'
+
+Just copying from the browser URL bar should work with no changes.
+
+----
+
+[Please see the website for more information](https://427738.xyz/yt-dlp-rajiko/).
+If the website is down, an archived copy may be available on [the Internet Archive's Wayback Machine](https://web.archive.org/web/*/https://427738.xyz/yt-dlp-rajiko/).
-サイトが無くなった場合は、おそらく[Internet ArchiveのWayback Machineにアーカイブされています](https://web.archive.org/web/*/https://427738.xyz/yt-dlp-rajiko/index.ja.html)。
+[日本語訳は公式サイトをご覧ください。](https://427738.xyz/yt-dlp-rajiko/index.ja.html)
+サイトが無くなった場合は、多分[Internet ArchiveのWayback Machineにアーカイブされています](https://web.archive.org/web/*/https://427738.xyz/yt-dlp-rajiko/index.ja.html)。