add readme

README.md

@@ -1,24 +1,41 @@
-## Description
-uni-verse-api
+![](./doc/badges/coverage.svg)
+# Uni-verse API
+Uni-verse is a platform allowing music creators to share both their content and their resources. 
 
-## Installation
+This API serves for business rules, and is used aas main API as opposed to a microservice architecture. 
 
-```bash
-$ npm install
-```
+It communicates with another tinier API for fingerprinting purposes, and with 3 clients
+## Documentation
 
-## Running the app
+### UML
+![UML](doc/assets/UML.png)
 
-```bash
-# development
-$ npm run start
+### Routes
+Routes are documented automatically using Swagger.
 
-# watch mode
-$ npm run start:dev
+Documentation can be found at [https://uni-verse.api.vagahbond.com/api/v2/docs/](https://uni-verse.api.vagahbond.com/api/v2/docs/)
+## Setup
 
-# production mode
-$ npm run start:prod
-```
+### Requirements
+* Docker
+* docker-compose
+
+### Run
+To setup locally:
+* Clone this repository
+* Fill env file according to your needs
+* Run `docker-compose up`.
+
+
+## Production
+Production is automaticaly updated thanks to the CI pipeline.
+
+It runs on a self hosted Kubernetes cluster. So far, we use a subdomain of vagahbond.com for money reasons.
+
+The url is [uni-verse.api.vagahbond.com](uni-verse.api.vagahbond.com)
+
+The pipeline builds a docker image that it sends to a private registry. 
+Then, production pods that are restarted will pull the latest version of the api.
 
 ## Test
 
@@ -29,6 +46,6 @@ $ npm run test
 # e2e tests
 $ npm run test:e2e
 
-# test coverage
+# test coverage and coverage badge generation
 $ npm run test:cov
 ```

package.json

@@ -16,7 +16,7 @@
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest --runInBand --detectOpenHandles --forceExit",
     "test:watch": "jest --watch",
-    "test:cov": "jest --coverage && make-coverage-badge",
+    "test:cov": "jest --coverage && make-coverage-badge --output-path=badges/coverage.svg",
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json"
   },