Add atom feeds

[x_status_git] / README.markdown

diff --git a/README.markdown b/README.markdown
index 9cd2346d66f7af5d6fe73f7364227beba2a16ad6..4195de1a79e2b8583dd581b48d01f62defa3b7b7 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -99,13 +99,13 @@ Note that these paths **do not** have a trailing slash.
       `</statuses.jsonld>;rel=meta;type="application/ld+json"` (or
       equivalent) **must** be provided.
 
- +  **`GET /$YYYY-MM`** (where `$YYYY-MM` is an `xsd:gYearMonth`):
+ +  **`GET /statuses/$YYYY-MM`** (where `$YYYY-MM` is an `xsd:gYearMonth`):
     Serve the file at `/.topic.html`.
     A `Link` header with the value
       `</$YYYY-MM.jsonld>;rel=meta;type="application/ld+json"` (or
       equivalent) **must** be provided.
 
- +  **`GET /$YYYY-MM/*`** (where `$YYYY-MM` is an `xsd:gYearMonth`):
+ +  **`GET /statuses/$YYYY-MM/*`** (where `$YYYY-MM` is an `xsd:gYearMonth`):
     Serve the file at `/.status.html`.
     A `Link` header with the value
       `</$YYYY-MM.jsonld>;rel=meta;type="application/ld+json"` (or
@@ -143,7 +143,7 @@ In all cases, for `/$PATH.jsonld`, this just serves the file at
  +  **`GET /statuses.jsonld`**:
     Serve the file at `/statuses/index.jsonld`.
 
- +  **`GET /$YYYY-MM.jsonld`** (where `$YYYY-MM` is an
+ +  **`GET /statuses/$YYYY-MM.jsonld`** (where `$YYYY-MM` is an
       `xsd:gYearMonth`):
     Serve the file at `/$YYYY-MM/index.jsonld`.
 
@@ -154,6 +154,24 @@ In all cases, for `/$PATH.jsonld`, this just serves the file at
       `[0-9A-Za-z_-]+`):
     Serve the file at `/topics/$TOPIC/index.jsonld`.
 
+### Atom responses
+
+These responses **should** be served with a `Content-Type` of
+  `application/atom+xml`.
+In all cases, for `/$PATH.atom`, this just serves the file at
+  `/$PATH/index.atom`.
+
+ +  **`GET /statuses.atom`**:
+    Serve the file at `/statuses/index.atom`.
+
+ +  **`GET /statuses/$YYYY-MM.atom`** (where `$YYYY-MM` is an
+      `xsd:gYearMonth`):
+    Serve the file at `/$YYYY-MM/index.atom`.
+
+ +  **`GET /topics/$TOPIC.atom`** (where `$TOPIC` matches
+      `[0-9A-Za-z_-]+`):
+    Serve the file at `/topics/$TOPIC/index.atom`.
+
 ### Other Headers
 
 All responses **should** have a `Access-Control-Allow-Origin` header