dan/covid
1
0
Fork 0
mirror of https://github.com/danbulant/covid synced 2026-06-16 13:11:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add documentation

Browse source
This commit is contained in:
Daniel Bulant 2020-03-09 18:49:15 +01:00
parent 65c951e2d1
commit fd75aad2cd
2 changed files with 19 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/README.md Normal file
View file

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

4
docs/TYPES.md Normal file
View file

@ -0,0 +1,4 @@
# Types
* `nothing_to_show` - This page has nothing to show you as of now
* `done` - Operation succeeded, without any output