From 51e5b6dac7bb989282e2561c06670da590d520d5 Mon Sep 17 00:00:00 2001 From: mappu Date: Sun, 8 Oct 2017 16:18:52 +1300 Subject: [PATCH] doc: document URL information --- _dist/README.txt | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/_dist/README.txt b/_dist/README.txt index c7754d2..10a5ac5 100644 --- a/_dist/README.txt +++ b/_dist/README.txt @@ -34,6 +34,14 @@ You can use contented as a standalone upload server, or you can use the SDK to e Title used in web interface (default "contented") ` +=USAGE (HTTP)= + +The server responds on the following URLs: + +- `/get/{ID}`: Download item content +- `/info/{ID}`: Get item content metadata (JSON) +- `/about`: Get server metadata (JSON) + =USAGE (EMBEDDING FOR WEB)= Your webpage should load the SDK from the contented server, then call the `contented.init` function to display the upload widget over the top of an existing DOM element.