Add clipboard

1 files changed, 31 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9230a9d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# Captura
+
+Bring your own backend screen recorder
+
+## Bring Your Own Backend (Protocol version 1.0)
+
+Captura allows you to define a URL that will be used to POST the recording.
+
+### The Request
+
+A `POST` will be made to the request, with the payload containing the binary
+contents of the file. You can expect the following headers:
+
+* `User-Agent`: `Captura/1.0`
+* `Content-Type`: `video/mp4` or `image/gif`, depending on the output format
+  selected.
+
+### Authentication / Authorization
+
+We will only do a POST request, so if you need any type of keys or user
+identifiers, include them in the URL itself (eg. via path elements or
+in the query parameters)
+
+### Expected Response
+
+If the upload is successful, the response *MUST* be a JSON object containing
+a key called `url` with a value of type `string` corresponding to the URL
+where the file is available. The status code *MUST* be 201 Created.
+
+Any response code other than 201 Created will be treated as an error. Captura
+will not re-attempt an upload.