diff --git a/README.md b/README.md index 5892616..8d56a0a 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,12 @@ ### Summary The LACCPass Client component allows Ministries of Health to handle the onboarding, as well as the issuance and delivery of health certificates to patients. -This section contains the steps to run the LACPass Client component, and specifies how to use the endpoints. +This section describes the steps to run the LACPass Client component, and specifies how to use the endpoints. ### Requirements - Make sure you have up and running and instance of the LACPass Client component available at https://github.com/lacchain/IPS-national-backend - Access to the client-helper executable script available at https://github.com/lacchain/IPS-national-backend#lacchain-setup-and-onboard-helper +- Internet access ### Verify Service availability 1. Running the lacpass-lacchain component from IPS-national-backend will expose the service at port 3010 @@ -25,14 +26,15 @@ This section contains the steps to run the LACPass Client component, and specifi It is time to run the CLI (Client helper executable script) to setup your DID and set some keys. 1. Make sure you have verified the service availability as described in the previous section -2. Before running the CLI make sure to execute this in a linux bash terminal: ./client-helper.sh +2. Before running the CLI make sure to execute this in a linux bash terminal: +`$ ./client-helper.sh` 3. Now enter the URL of the lacpass-lacchain verified in the previous section +![](https://github.com/lacchain/LACPass-client/blob/master/docs/examples/apiURL.png) 4. The following menu is presented: - ![](https://github.com/lacchain/LACPass-client/blob/master/docs/examples/CLIMainMenu.png) -5. If you don't have a PKI or don't have any signing key to attest health certificates then you can create a Self-Signed Certificate "SSC". Type that if needed and enter the required information. -- The end of this process will create a subdirectory named "certS" inside the directory you are running the script: +5. If you don't have a PKI or don't have any signing key to attest health certificates then you can create a Self-Signed Certificate (SSC). If this is the case, type 'SSC' and enter the required information. +- The end of this process will create a subdirectory named "certs" inside the directory you are running the script: ![](https://github.com/lacchain/LACPass-client/blob/master/docs/examples/certsDir.png) * NOTE: DSC.key will be the private key used to sign Health Certificates. For that: diff --git a/docs/examples/apiURL.png b/docs/examples/apiURL.png new file mode 100644 index 0000000..e8e176d Binary files /dev/null and b/docs/examples/apiURL.png differ