code.ivysaur.me/contented
1
0
Fork 0
Code Issues 8 Pull Requests Releases 5 Wiki Activity

doc: document URL information

Browse Source
This commit is contained in:
mappu 2017-10-08 16:18:52 +13:00
parent b4ca24947d
commit 51e5b6dac7
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
_dist/README.txt
View File

@ -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.