url helpers, cgi response format

1 files changed, 26 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3c2dcd0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Communique
+
+Communique aims to be an activitypub platform that abstracts outboxes/inboxes away from 
+handler implementations.
+
+1) handlers are defined in a config file
+2) these are read into the registry which allows lookup by name or by fqdn
+
+
+# CGI
+
+Communique uses CGI as the API between itself and your scripts. These scripts are only run **internally** and are never executed from a TCP request.
+
+## Response API
+
+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 an `OrderedCollection` of ActivityStream `Object`s.
+
+See `sample-cgi-handler.sh` for an example
+
+## Processing
+
+Communique will iterate through this collection of objects and add them to the outbox for the handler for that script, if they have not been posted in the last hour. **(TODO make the dedupe window configurable)**
\ No newline at end of file