diff --git a/README.md b/README.md index 539dd13..8e5bc99 100644 --- a/README.md +++ b/README.md @@ -84,20 +84,13 @@ Our guiding principles for development of this namespace are the "[Rules for Sta
-- **\** +- **\** Item - (optional | multiple) + (optional) - This element specifies a point in time during the podcast that can be linked to directly and optionally supplemented with additional content. - - Attributes: - - - `start` (required) Used to identify the starting point of the chapter within the podcast. Start time is expressed as seconds since the start time of the podcast. - - `title` (optional) Used as a user facing identifier for this chapter. - - `href` (optional) Points to a url containing additional user facing content, like an image or wiki entry. - - `type` (optional) This attribute is strongly encouraged if `href` is used so that apps can handle the external chapter content appropriately. + Links to an external file **(sample needed)** containing chapter data for the episode. The mime type of the file should be given - JSON prefered, `application/json`.
@@ -118,7 +111,7 @@ Our guiding principles for development of this namespace are the "[Rules for Sta
-- **\** +- **\**[name of person]**** Channel or Item (optional | multiple) @@ -143,18 +136,20 @@ Our guiding principles for development of this namespace are the "[Rules for Sta
-- **\**[uri of media asset]**\** +- **\** Channel (optional | single) Item (optional | multiple) - This element is meant to provide alternate versions of an enclosure, such as low or high bitrate, or alternate formats or alternate uri schemes, like IPFS or live streaming. There may be multiple alternateEnclosure elements in an item, but there must be no more than one in a channel. The presence of this element at the - channel level would be useful for adding a video/audio trailer or intro media that introduces the listener to the podcast. For instance, in a podcast of an audiobook, this could be the book's - introduction or preface. The alternateEnclosure element always refers to an "alternate" media version. The standard RSS enclosure element is always the default media to be - played. - - All attributes are required except for "stream". "stream" is a boolean attribute that indicates the uri points to a streaming media that is not downloadable. + This element is meant to provide alternate versions of an enclosure, such as low or high bitrate, or alternate formats or alternate uri schemes, like IPFS or live streaming. There may be multiple alternateEnclosure elements in an item, but there must be no more than one in a channel. The presence of this element at the channel level would be useful for adding a video/audio trailer or intro media that introduces the listener to the podcast. For instance, in a podcast of an audiobook, this could be the book's introduction or preface. The alternateEnclosure element always refers to an "alternate" media version. The standard RSS enclosure element is always the default media to be played. + + - `url` (required) This is the url to the media asset. + - `type` (required) Mime type of the media asset. + - `length` (required) Duration of media asset in seconds. + - `bitrate` (optional) Encoding bitrate of media asset. + - `title` (required) Alternate assets need a title since main title will apply to primary asset. + - `stream` (optional) Boolean attribute that indicates the uri points to a streaming media that is not downloadable.
@@ -172,20 +167,19 @@ Our guiding principles for development of this namespace are the "[Rules for Sta
-- **\**[url to a large image file]**\** +- **\** Channel or Item (optional | single) - This is assumed to point to an image that is 1000px or larger in size. The image must be square (1:1 ratio). The image content may differ from other images specified in - the feed where appropriate. + This is assumed to point to an image that is 1000px or larger in size. The image must be square (1:1 ratio). The image content may differ from other images specified in the feed where appropriate. All attributes are required.
-- **\**[url to a medium image file]**\** +- **\** Channel or Item @@ -198,7 +192,7 @@ Our guiding principles for development of this namespace are the "[Rules for Sta
-- **\**[url to a small image file]**\** +- **\** Channel or Item @@ -211,18 +205,19 @@ Our guiding principles for development of this namespace are the "[Rules for Sta
-- **\**[url for the show at the platform]**\** +- **\**[user provided content to link]**\** Channel or Item (optional | multiple) - This element lists multiple possible donation/funding links for the podcast. The node value should contain the full url of the donation page. + This element lists multiple possible donation/funding links for the podcast. Attributes: + - `url` (required) Full url to the specific show on the funding platform. - `platform` (required) Identifies a payment or funding platform for the podcast. Service slugs should be recorded here in the repository. - - `title` (optional) Used as free form string from the podcast owner to show to the listeners. Ex. "Support us on Patreon!" + - `node value` (required) Used as free form string from the podcast owner to show to the listeners. Ex. "Support us on Patreon!"