diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 12 |
1 files changed, 10 insertions, 2 deletions
@@ -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 |