Update documentation url

ByteDream 2022-05-01 17:13:40 +02:00
parent 2418ae6191
commit 2c51627d1b

@ -2,7 +2,7 @@
## Documentation ## Documentation
The documentation is available on [pkg.go.dev](https://pkg.go.dev/github.com/ByteDream/crunchyroll-go). The documentation is available on [pkg.go.dev](https://pkg.go.dev/github.com/ByteDream/crunchyroll-go/v2).
## Login ## Login
@ -76,7 +76,7 @@ Downloading can be archived via a struct function of `crunchyroll.Format`: `Down
This downloads, obviously, the format. It takes a `crunchyroll.Downloader` struct as argument where detailed information how to download can be specified. This downloads, obviously, the format. It takes a `crunchyroll.Downloader` struct as argument where detailed information how to download can be specified.
A simple `Downloader` struct which will fit the most needs can be created with the `crunchyroll.NewDownloader(...)` function. A simple `Downloader` struct which will fit the most needs can be created with the `crunchyroll.NewDownloader(...)` function.
You can specify an `io.Writer` where the video should be downloaded to, how many goroutines should be used for parallel segment downloading or if you want to merge the video via ffmpeg and may specify some ffmpeg options. You can specify an `io.Writer` where the video should be downloaded to, how many goroutines should be used for parallel segment downloading or if you want to merge the video via ffmpeg and may specify some ffmpeg options.
To see all functions of the `Downloader` struct check the [documentation](https://pkg.go.dev/github.com/ByteDream/crunchyroll-go#Downloader). To see all functions of the `Downloader` struct check the [documentation](https://pkg.go.dev/github.com/ByteDream/crunchyroll-go/v2#Downloader).
Just a quick dive in: Crunchyroll uses [mpeg transport streams](https://en.wikipedia.org/wiki/MPEG_transport_stream) to deliver videos. Just a quick dive in: Crunchyroll uses [mpeg transport streams](https://en.wikipedia.org/wiki/MPEG_transport_stream) to deliver videos.
This means an episode is split into multiple tiny video files (generally around 718 - 721) which are referred as _segments_ here. This means an episode is split into multiple tiny video files (generally around 718 - 721) which are referred as _segments_ here.