diff --git a/README.md b/README.md
index 6233f43..6e10fdf 100644
--- a/README.md
+++ b/README.md
@@ -26,8 +26,8 @@ builds when you don't add `--release`.)
### Configuration
For now, you will need to provide Rocket with configuration to tell it at which
-public URL Podbringer is hosted. This needs to be done even if you are not using a
-reverse proxy, in which case you need to provide it with the proxied URL. You
+public URL Podbringer is hosted. This needs to be done even if you are not using
+a reverse proxy, in which case you need to provide it with the proxied URL. You
can also use the configuration to configure a different address and/or port.
Just create a `Rocket.toml` file that contains (or copy `Rocket.toml.example`):
@@ -45,17 +45,17 @@ configuration, see: .
Podbringer currently has no front-end or web interface yet that can help you
use it. Until then, you just have to enter the right service-specific RSS feed
-URL in your favorite podcast client to start using it.
-
-Given the Mixcloud URL , the URL you
-need to use for Podbringer is comprised of the following parts:
+URL in your favorite podcast client to start using it. For example:
```text
https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband
- |------------------------------| |-------||--------------|
- The Podbringer public URL Service User @ service
+ |------------------------------| |------| |-------------|
+ The Podbringer public URL Service Service ID
```
+So, the URL consists of the location of Podbringer, the fact that you want the feed,
+the name of the service and the ID that identifies something list on that service.
+
### Feed item limit
To prevent feeds with a very large number of items, any feed that is returned
@@ -63,7 +63,43 @@ 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`
+
+```text
+ https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband?limit=1000`
+```
+
+### Service: Mixcloud
+
+For Mixcloud, a feed can be constructed of everything that a user posted.
+Given the Mixcloud URL like , the
+`myfavouriteband` part of the URL is the Mixcloud username and can be used as
+the service ID.
+
+```text
+ https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband
+ |------------------------------| |------| |-------------|
+ The Podbringer public URL Service Username
+```
+
+### Service: YouTube
+
+For YouTube, a feed can either be constructed of a channel or a playlist.
+Given the YouTube channel URL like ,
+the `favouritechannel` part of the URL is the YouTube channel ID.
+Given the YouTube playlist URL
+, the
+`PLsomeplaylistidentifier` part of the URL is the YouTube playlist ID.
+Either the channel or playlist ID can be used as the service ID.
+
+```text
+ https://my.domain.tld/podbringer/feed/youtube/favouritechannel
+ |------------------------------| |-----| |--------------|
+ The Podbringer public URL Service Channel ID
+
+ https://my.domain.tld/podbringer/feed/youtube/PLsomeplaylistidentifier
+ |------------------------------| |-----| |----------------------|
+ The Podbringer public URL Service Playlist ID
+```
## License
diff --git a/templates/index.html.tera b/templates/index.html.tera
index c9a3af7..be7d078 100644
--- a/templates/index.html.tera
+++ b/templates/index.html.tera
@@ -5,15 +5,21 @@
URL in your favorite podcast client to start using it.
- Given the Mixcloud URL , the URL you
- need to use for Podbringer is comprised of the following parts:
+ The URL you need to use for Podbringer is comprised of the following parts:
https://my.domain.tld/podbringer/feed/mixcloud/myfavouriteband
- |------------------------------| |-------||--------------|
- The Podbringer public URL Service User @ service
+ |------------------------------| |------| |-------------|
+ The Podbringer public URL Service Service ID
- The Podbringer location URL of this instance is: {{ url }}
+ Supported services are:
+
+ - Mixcloud (service ID is Mixcloud username)
+ - YouTube (service ID is YouTube channel or playlist ID)
+
+
+
+ The Podbringer location URL of this instance is: {{ url }}.