diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..488c758 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +# Documentation + +## Setting it up + +* Clone (either using git or **hub**) this repository +* Install dependencies (`npm i`) +* Run it! (`npm start`) + +## Format + +Every response is in JSON and contains at least these fields: + +* `code` - HTTP status code +* `type` - Type of response, see [types](TYPES.md) +* `data` - Might be missing, depends of `type`. diff --git a/docs/TYPES.md b/docs/TYPES.md new file mode 100644 index 0000000..e9b06b2 --- /dev/null +++ b/docs/TYPES.md @@ -0,0 +1,4 @@ +# Types + +* `nothing_to_show` - This page has nothing to show you as of now +* `done` - Operation succeeded, without any output