aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJulio Capote <jcapote@gmail.com>2022-12-31 02:20:02 +0000
committerJulio Capote <jcapote@gmail.com>2022-12-31 02:20:02 +0000
commitc500a2be38afcbb5688537d97c7c3ee30a57dba4 (patch)
tree79cf1884ca7529299646b567b7705378bdf08fd3 /README.md
parent74ffcfe6b2c80b7cf459798dc42bd278075ccb50 (diff)
downloadcommunique-c500a2be38afcbb5688537d97c7c3ee30a57dba4.tar.gz
parse and persist feeds from handlers
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3c2dcd0..094e6ce 100644
--- a/README.md
+++ b/README.md
@@ -13,11 +13,19 @@ Communique uses CGI as the API between itself and your scripts. These scripts ar
## Response API
+> The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL
+> NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and
+> "OPTIONAL" in this document are to be interpreted as described in
+> RFC 2119.
+
Your CGI script MUST emit a valid CGI response.
-Your CGI script reponse MUST be of content type `application/activity+json`.
+Your CGI script reponse MUST be of one of these content types:
+
+* `application/atom+xml`
+* `application/rss+xml`
-Your CGI script reponse MUST be an `OrderedCollection` of ActivityStream `Object`s.
+Your CGI script reponse MUST be an RSS or ATOM feed (or at least something [gofeed](https://github.com/mmcdole/gofeed) can parse)
See `sample-cgi-handler.sh` for an example