diff --git a/README.md b/README.md index 7a80268..4b45236 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # xml-feed-generator -an RSS/atom feed generator for my personal site +an RSS/atom feed generator for my personal site :cat: + +--- + +the basic logic of this PHP script: +1. matches files in a specificied directory +2. parses values retrieved from the following strings/HTML elements, as children of a feed ``: + - `

` as `` + - the `datetime` attribute of `<time>` as `<updated>` + - `<element class="p-summary">` as `<summary>` + - `<element class="e-content">` (or `<element class="entry"` for older markup) as `<content>` + - `/path/to/blog/entry` as `<id>`/`<link>` +3. outputs all of the above to `articles.xml` in another directory. + +feel free to modify for your needs!