From cb1d36754abb27474c19d3299b64df88d07c77c8 Mon Sep 17 00:00:00 2001
From: Mirco Nasuti <mirco.nasuti@chuv.ch>
Date: Fri, 8 Jan 2016 16:08:09 +0100
Subject: [PATCH] update README

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 884099364..5e46a4556 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,15 @@ This is the MIP implementation.
 
 Run `mvn clean`, `mvn package` and `java -jar target/*.jar` to compile and run a demo.
 To use it, you need to configure some URLs and register an openid client on the HBP platform.
+
+## 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 a script to populate the DB for testing purpose;
+* Clean swagger annotations;
+* Implementation missing API features (updates, deletes, special parameters);
+* Implement logout;
+* Adapt frontend (add introduction page, hide header/footer when not logged in).
-- 
GitLab