diff --git a/README.md b/README.md index 7e8ca26..8064bc8 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,15 @@ need to use for Podbringer is comprised of the following parts: The Podbringer location URL Service User @ service ``` +### Feed item limit + +To prevent feeds with a very large number of items, any feed that is returned +contains at most 50 items by default. If you want to have more (or less) items, +provide the limit in the URL by setting the `limit` parameter. + +For example, to get up until 1000 items the URL becomes: +`https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband?limit=1000` + ## License Podbringer is licensed under the MIT license (see the `LICENSE` file or diff --git a/src/lib.rs b/src/lib.rs index 43a7d1a..2af6353 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -92,6 +92,8 @@ pub(crate) async fn download(file: PathBuf, backend: &str) -> Result { } /// Handler for retrieving the RSS feed of user on a certain back-end. +/// +/// The limit parameter determines the maximum of items that can be in the feed. #[get("/feed//?")] async fn feed( backend: &str,