[docs] Update README as per #72
This commit is contained in:
parent
7247b7be66
commit
a737d37105
10
README.md
10
README.md
|
@ -8,7 +8,7 @@ Generate CUE sheet from timestamps in youtube video description.
|
|||
2. The video has timestamps in the video description.
|
||||
3. The video is publicly available on Youtube.
|
||||
|
||||
`youtube-cue` will read the video description, get the timestamps and generate a [CUE sheet][cue] accordingly.
|
||||
`youtube-cue` will read the video description, get the timestamps and generate a [CUE sheet][cue] accordingly. It will also work if track durations are used instead of timestamps.
|
||||
|
||||
## Anti-features
|
||||
|
||||
|
@ -42,6 +42,12 @@ You need to pass 2 parameters, a Youtube URL and a output CUE filename. YouTube
|
|||
|
||||
where $VIDEOTITLE is the title of the YouTube video.
|
||||
|
||||
--timestamps-only Do not try to parse the timestamps as track durations
|
||||
--timestamps-are-durations Parse timestamps as durations
|
||||
|
||||
The above 2 are only needed to force behaviour in very specific edge cases, they should
|
||||
not be required for most files.
|
||||
|
||||
Examples
|
||||
$ youtube-cue --audio-file audio.m4a "https://www.youtube.com/watch?v=THzUassmQwE"
|
||||
"T A Y L O R S W I F T – Folklore [Full album].cue" saved
|
||||
|
@ -66,7 +72,7 @@ function ytdl.album() {
|
|||
|
||||
## HACKING
|
||||
|
||||
- If this video does not work on a specific video, please attach the complete output
|
||||
- If it does not work on a specific video, please attach the complete output
|
||||
- Pull Requests are welcome that add support for a better parser without breaking the existing tests
|
||||
- Please add tests for any new functionality
|
||||
|
||||
|
|
Loading…
Reference in New Issue