Fix index.html to only fetch topics once

[x_status_git] / README.markdown

diff --git a/README.markdown b/README.markdown
index a0f841366a0c919f49d79f265640fcae53652b9c..0d7d027a28b3eb8ffd6bc885e647462d5277df71 100644 (file)
--- a/README.markdown
+++ b/README.markdown
@@ -1,6 +1,6 @@
-# Status.git
+# x_status_git
 
-A minimal git‐based self‐hosted status publishing solution.
+A minimal git‐based microblog.
 
 ## What It Is
 
@@ -71,7 +71,9 @@ You’ll need to supply some variables there, too :—
 ## Server Configuration
 
 Your server should be configured to serve the following files from the
-  provided `PUBLIC_DIRECTORY` in response to the following requests :—
+  provided `PUBLIC_DIRECTORY` in response to the following requests.
+For people using Caddy to serve their content, a sample `Caddyfile` is
+  included in this repository.
 
 ### H·T·M·L responses
 
@@ -97,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
@@ -128,6 +130,16 @@ Note that these paths **do not** have a trailing slash.
       `</$TOPIC.jsonld>;rel=meta;type="application/ld+json"` (or
       equivalent) **must** be provided.
 
+### X·H·T·M·L responses
+
+These responses **must** be served with a `Content-Type` of
+  `application/xhtml+xml` (or equivalent).
+Note that these paths **do not** have a trailing slash.
+
+ +  **`GET /$IRI`** (where `$IRI` contains a colon and no slash):
+    Serve the file at `/.lookup.xhtml`.
+    This can be used to look up statuses by their identifier.
+
 ### Json‐L·D responses
 
 These responses **should** be served with a `Content-Type` of
@@ -141,7 +153,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`.
 
@@ -152,6 +164,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
@@ -207,6 +237,13 @@ The files which represent a status are as follows :—
     The contents of this file **must** give the author’s URL,
       optionally followed by a trailing newline.
 
+ +  **`2=TITLE`** (where `TITLE` might be anything):
+    This file is **optional** and indicates the title of the status.
+    The value of `TITLE` **should** be a file·system‐friendly version
+      of the title, but is ignored.
+    The contents of this file **must** give the title of the status,
+      optionally followed by a trailing newline.
+
  +  **`3=YYYY-MM-DD`** (where `YYYY-MM-DD` is a date):
     This file is **required** and indicates the date of the status.
     Only one date is currently supported.
@@ -231,7 +268,7 @@ The files which represent a status are as follows :—
 Files with names that begin with the strings `2=` or `x_status_git_`
   are reserved for backwards‐compatible extensions.
 
-Status.git has no opinion on how these files make their way into the
+x_status_git has no opinion on how these files make their way into the
   Git repository, except that all the files for a single status should
   be added in the same commit.
 The intention is that the simple nature of these files will make them
@@ -240,7 +277,7 @@ The intention is that the simple nature of these files will make them
 ## I Am Computer, How Do I Get Status?
 
 Assume you are given a U·R·L `resource_url` which you think points to
-  some kind of Status.git resource.
+  some kind of x_status_git resource.
 Start by resolving it as follows :—
 
 01. Make a `HEAD` request to `resource_url`.
@@ -340,5 +377,8 @@ Statuses themselves have the following properties :—
  +  **`subject`** [`dcterms:subject`] (optional):
     The topic of the status, for topic statuses.
 
+ +  **`title`** [`dcterms:title`] (optional):
+    The title of the status.
+
  +  **`content`** [`sioc:content`]:
     The content of the status, as an `rdf:XMLLiteral`.