From c8d390dd01577c1b0d173ff31c9b096baff60125 Mon Sep 17 00:00:00 2001
From: mikeromard <146881896+mikeromard@users.noreply.github.com>
Date: Thu, 9 Nov 2023 09:45:55 -0400
Subject: [PATCH] Update README.md

---
 README.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index af73cd3..56a462f 100644
--- a/README.md
+++ b/README.md
@@ -32,4 +32,5 @@ This is a proof-of-concept for updating an RSS feed from a markdown file that se
 * If `markdown_to_rss.py` finds more than one new entry in `test_product_updates.md`, it makes no effort to sort them. The sample entries in `test_product_updates.md` are from most recent to oldest, and they are processed in that order. 
     * For example, if both the first and second entries in `test_product_updates.md` are new, the first entry gets added as the first `<item>` in `test_rss_feed.xml`, and then the second entry gets added as the first `<item>`, meaning that the first entry is now the second `<item>`. This could be handled better by reversing the order of the list of entries before processing them. 
     * Both entries would also have identical timestamps in their `<pubDate>` elements. It may be a good idea to update the timestamp when processing each entry, and introduce a 1 second delay to ensure that each timestamp is unique. If this is implemented, the last timestamp should also be used to update the `<pubDate>` for the feed itself, since it should presumably not be older than any of the `<pubDate>` timestamps in the `<item>` elements. 
-* Where a new `<item>` is inserted is hard-coded. It would be good if the script could determine the index of the first `<item>` and insert each new `<item>` at that index, rather than relying on the number of elements before the first `<item>` staying the same.
\ No newline at end of file
+* Where a new `<item>` is inserted is hard-coded. It would be good if the script could determine the index of the first `<item>` and insert each new `<item>` at that index, rather than relying on the number of elements before the first `<item>` staying the same.
+* The script relies on entries in the markdown file being formatted in a specific way, where each entry starts with and h2 (##) and the first line of text after that is the category of the entry (such as New Feature, Alpha, Beta, and so on). So if there's no category specified, the first paragraph of the entry gets treated as a category anyway and doesn't render in the `<description>` element of the `<item>` and doesn't appear in the body of the post when you view it in an RSS reader. 
\ No newline at end of file