Skip to content

Commit e5f7ece

Browse files
authored
Refactor readme.txt for improved structure and clarity
Updated formatting and organization of the readme file, including section headings and content adjustments for clarity.
1 parent f8841dd commit e5f7ece

1 file changed

Lines changed: 36 additions & 28 deletions

File tree

readme.txt

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,21 @@ Set up multiple podcast feeds using built-in WordPress posts. Includes a podcast
1414

1515
Podcasting is a method to distribute audio and video episodes through a feed to which listeners can subscribe. You can publish podcasts on your WordPress site and make them available for listeners in Apple Podcasts and through direct feed links for other podcasting apps by following these steps:
1616

17-
=== Create your podcast ===
17+
= Technical Notes =
18+
19+
* Requires PHP 7.4+.
20+
* RSS feeds must not be disabled.
21+
22+
== Installation ==
23+
24+
1. Install the plugin via the plugin installer, either by searching for it or uploading a .zip file.
25+
2. Activate the plugin.
26+
3. Head to Posts → Podcasts and add at least one podcast.
27+
4. Create a post and insert an audio embed (or a podcast block in Gutenberg) and select a Podcast feed to include it in.
28+
29+
== Usage ==
30+
31+
= Create your podcast =
1832

1933
From the WordPress Admin, go to Podcasts.
2034
To create a podcast, complete all of the "Add New Podcast" fields and click "Add New Podcast".
@@ -34,37 +48,25 @@ To create a podcast, complete all of the "Add New Podcast" fields and click "Add
3448

3549
Repeat for each podcast you would like to create.
3650

37-
=== Add content to your podcast ===
51+
= Add content to your podcast =
3852

3953
* Create a new post and assign it to one or more Podcasts using the panel labeled Podcasts.
4054
* Upload or embed an audio file into this post using any of the usual WordPress methods. If using the new block-based WordPress editor (sometimes referred to as Gutenberg), insert a Podcast block. Only one Podcast block can be inserted per post.
4155
* For more advanced settings, use the Podcasting meta box to mark explicit content or closed captioning available, season number, episode number, episode type, add a transcript and to optionally specify one media item in the post if you have more than one in your post. In the block-based editor, these are the block settings that appear in the sidebar when the podcast block is selected.
4256
* Transcript: If desired, an optional transcript can be added from the settings of the Podcast block. This will add a Podcast Transcript block, allowing you to add a transcript consisting of time codes, citations, and paragrah text that can be embedded in the post, linked to an external plain HTML file, or linked in a special `<podcast:transcript>` XML element.
4357

44-
=== Submit your podcast feed to Apple Podcasts ===
58+
= Submit your podcast feed to Apple Podcasts =
4559

4660
* Each podcast has a unique feed URL you can find on the Podcasts page. This is the URL you will submit to Apple.
4761
* Ensure you test feeds before submitting them, see [Apple's "Test a Podcast page"](https://help.apple.com/itc/podcasts_connect/#/itcac471c970) for more information.
4862
* Once the validator passes, submit your podcast. Podcasts submitted to Apple Podcasts do not become immediately available for subscription by others. They are submitted for review by Apple staff, see [Apple's "Submit a podcast" page](https://help.apple.com/itc/podcasts_connect/#/itcd88ea40b9) for more information.
4963

50-
=== Submit your podcast feed to Pocket Casts
64+
= Submit your podcast feed to Pocket Casts =
5165

5266
* Validate your feeds at [https://www.castfeedvalidator.com/ Cast Feed Validator] before submitting them.
5367
* Submit the podcast feed to https://pocketcasts.com/submit/.
5468

55-
=== How do I get my podcast featured on Pocket Casts?
56-
57-
The Featured section of Pocket Casts is human-curated. To ensure that all podcasts have an equal opportunity at being featured, selections are made on the basis of merit.
58-
59-
If you’d like to suggest your podcast for a featured spot, reach out to `curation@pocketcasts.com`
60-
61-
For more information, [https://pocketcasts.com/podcast-producers/ read more].
62-
63-
=== How do I submit private and paid podcast feeds?
64-
65-
Follow this documentation to submit [https://support.pocketcasts.com/article/password-protected-podcasts-2/ private and paid podcast feeds]
66-
67-
=== Control how many episodes are listed on the feed ===
69+
= Control how many episodes are listed on the feed =
6870

6971
If you want to adjust the default number of episodes included in a podcast RSS feed, then utilize the following to do so...
7072

@@ -84,7 +86,7 @@ function podcasting_feed_episodes_per_page( $qty ) {
8486
}
8587
`
8688

87-
=== Customize RSS feed ===
89+
= Customize RSS feed =
8890

8991
If you want to modify RSS feed items output, there is a filter for that:
9092

@@ -98,10 +100,23 @@ function podcasting_feed_item_filter( $feed_item = array(), $post_id = null, $te
98100
add_filter( 'simple_podcasting_feed_item', 'podcasting_feed_item_filter', 10, 3 );
99101
`
100102

101-
=== Technical Notes ===
103+
== Frequently Asked Questions ==
102104

103-
* Requires PHP 7.4+.
104-
* RSS feeds must not be disabled.
105+
= How do I get my podcast featured on Pocket Casts? =
106+
107+
The Featured section of Pocket Casts is human-curated. To ensure that all podcasts have an equal opportunity at being featured, selections are made on the basis of merit.
108+
109+
If you’d like to suggest your podcast for a featured spot, reach out to `curation@pocketcasts.com`
110+
111+
For more information, [https://pocketcasts.com/podcast-producers/ read more].
112+
113+
= How do I submit private and paid podcast feeds? =
114+
115+
Follow this documentation to submit [https://support.pocketcasts.com/article/password-protected-podcasts-2/ private and paid podcast feeds]
116+
117+
= Where do I report security bugs found in this plugin? =
118+
119+
Please report security bugs found in the source code of the Simple Podcasting plugin through the [Patchstack Vulnerability Disclosure  Program](https://patchstack.com/database/vdp/0d49ba54-688e-484d-9411-4716696aa79b). The Patchstack team will assist you with verification, CVE assignment, and notify the developers of this plugin.
105120

106121
== Screenshots ==
107122

@@ -112,13 +127,6 @@ add_filter( 'simple_podcasting_feed_item', 'podcasting_feed_item_filter', 10, 3
112127
5. Podcast Grid pattern
113128
6. Podcast Transcript block
114129

115-
== Installation ==
116-
117-
1. Install the plugin via the plugin installer, either by searching for it or uploading a .zip file.
118-
2. Activate the plugin.
119-
3. Head to Posts → Podcasts and add at least one podcast.
120-
4. Create a post and insert an audio embed (or a podcast block in Gutenberg) and select a Podcast feed to include it in.
121-
122130
== Changelog ==
123131

124132
= 1.9.1 - 2025-05-16 =

0 commit comments

Comments
 (0)