Work in progress with unreleased ephemeral, as well as README improve…

…ments

README.md

@@ -1,41 +1,28 @@
-# waardepapieren
+# Waardepapieren
 
-project for consortium of municipalities digitizing PoE services
+This project provides a full implementation example of how Discipl components can be used to issue and
+verify claims. In particular, how municipalities can issue 
 
-the project aims at a W3C verifiable credential compatible (or alike) solution based on discipl core for proving all kinds of facts atested for by an issuer (with a focus on municipalities as issuer).
 
-# Running 
+## Running 
+
+Running the applications is easiest done using docker-compose. 
 
-Running the applications is easiest done using docker-compose. Simply run `docker-compose up`.
 This will start 3 applications:
 
 - clerk-frontend
 - waardepapieren-service, with embedded ephemeral-server
-- nlx-mock, which mocks an NLX API, such that development can be done independently
-
-components:
-
-- client-frontend : frontend webapplication (js) embedded in the my-environment provided by the municipality, which connects to a discipl node to retrieve a needed proof.
-- clerk-frontend : frontend webapplication (js) which connects to a discipl node to retrieve a needed proof of a selected person (by referring to a BSN).
-- authorization-backend : simple serverside authorization script that enables access to the abundance service that delivers certain proofs to a given ssid (authenticated for the my-environment, or being a clerk)
-- validator-frontend : frontend webapplication (js) that can validate a proof
-- dashboard
-- revoke-service
-- waardepapieren-service
-
-these components might involve the following components from the discipl software stack:
-
-- discipl-abundance-service
-- discipl-4sacan
-- discipl-expo
-- discipl-rshiny
-- discipl-core
-- discipl-core-restapi
-- discipl-core-node
-- discipl-core-paper
-- discipl-core-nlx
-- discipl-core-iota
-- discipl-core-ipfs
-- discipl-core-irma
-
-architectural primer : https://docs.google.com/presentation/d/1sw7xi2UbmxRN3NBwQTn9kWw6-RNhygdRL5kccnZWUyE
+- nlx-mock, which is an nlx-outway that provides access to a mock BRP service
+
+Note that the nlx-mock and waardepapieren-service need a valid certificate for the demo NLX environment.
+
+1. Generate certificates as described [here](https://docs.nlx.io/get-started/create-certificates/)
+2. Run `docker-compose up`
+
+Alternatively, you can use an offline mock, which replicates the NLX environment.
+
+1. Run `docker-compose -f docker-compose-travis.yml up`
+
+
+
+