Basic support for Atom feeds

[Shrine-XSLT] / README.markdown

diff --git a/README.markdown b/README.markdown
index c7b84ae3cd306f5e925b176dc4470d1dbe3068af..0abeeb6d910fc95e24a168e43692b2b94b20ee3e 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -7,7 +7,6 @@ substantially changing the authoring flow.
 ## Features
 
 - Really simple shrine generation
-
 - One command: `make`
 
 ## Prerequisites
@@ -51,6 +50,31 @@ Finally, just run `make` from this directory, and H·T·M·L files
 corresponding to your source files will be created in the `public/`
 directory (which you can then serve statically from your server).
 
+## Atom Feeds
+
+Any `.atom` files you provide will automatically be filled out with
+`<id>`s, `<updated>` values, and other necessary information before
+being copied to the destination location. If you wish to use this
+feature, you will need to provide a `BASEIRI` variable when you run
+`make` to allow the X·S·L·T to transform relative links into absolute
+ones.
+
+It is recommended that :—
+
+- You do *not* provide your own `<id>`s and rely on the generated ones
+  (which will be an `oai:` URI derived from the file path).
+
+- You *do* manually provide `<updated>` times for individual entries
+  (although not the feed as a whole); otherwise every entry will be
+  marked as updated every time the feed is generated.
+
+- All `<link rel="alternate">` elements in `<entry>` elements use a
+  relative `@href` with a leading slash. This should point to the
+  *final* location of the entry (within, but not including, `public/`).
+
+There’s an example `feed.atom` provided so you can see what this
+  feature might look like in practice.
+
 ## Notes
 
 - The created files have a `.html` extension and need to be served
@@ -63,6 +87,10 @@ directory (which you can then serve statically from your server).
   output at `public/%/index.html` (where `%` is the filename and
   optional subdirectory). Only one level of subdirectory is supported.
 
+- For any files at `sources/*.xml` and `sources/*/*.xml`, files in the
+  folder with the same name (minus the `.xml`) will be copied over
+  verbatim.
+
 - The transformation doesn’t do any rewriting of links. Make sure you
   write them to point to the *final* location of the files, not their
   location within the `sources/` directory.