From a858fbb4e476dcc696f9b4f80beae63f8588a5c9 Mon Sep 17 00:00:00 2001
From: Mirco Nasuti <mirco.nasuti@chuv.ch>
Date: Tue, 5 Jul 2016 14:10:28 +0200
Subject: [PATCH] update README

---
 README.md | 32 +++++---------------------------
 1 file changed, 5 insertions(+), 27 deletions(-)

diff --git a/README.md b/README.md
index ce9c373c3..872eb01df 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,10 @@
 ## Introduction
 
-This is the MIP implementation.
+This is the MIP backend.
 
 ## Usage
 
-Build the project with `./build` and run it with `./run`.
-
-## API Documentation using Swagger (Springfox)
-
-The API documentation is available at `<BASE URL>/swagger-ui.html`. A JSON version is available at `<BASE URL>/v2/api-docs`
-
-## TODO
-
-* Implement SoapUI tests;
-* Clean code (both back-end front-end);
-* Sync with original Swagger description;
-* Externalize configuration (DB parameters, security enabled/disabled, ...);
-* Make user tests with multiple users;
-* Fix bugs.
-
-## BUGS
-
-* Export PDF does not work;
-
-### Maintenance
-
-* To keep an updated API documentation, the developers should keep synchronized both the auto-generated swagger file (from Java annotations) with the hand written one. You can follow this method to get a YAML description from the Java-annotated code:
-  * Add annotations to the Java code;
-  * Get JSON from `<BASE URL>/v2/api-docs`;
-  * Convert JSON to YAML on [http://jsontoyaml.com](http://jsontoyaml.com).
-  
\ No newline at end of file
+* Build the project: `./build.sh`
+* Run the project: `./run.sh`
+* Show live logs: `./log.sh` (CTRL+C to quit)
+* Stop and remove the running container: `./halt.sh`
-- 
GitLab