diff --git a/README.md b/README.md index 7477f06..668198d 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,35 @@ Flags: -v, --verbose verbose logging ``` +## Configuration + +Any of the flag values can be set using a YAML configuration file. By default it will try and read the file $HOME/.tps.yaml. + +### Example configuration (~/.tps.yaml) + +```yaml +hostname: em5.verint.training +username: apiclient +password: apiclient12345 +clientId: default +``` + +## Example usage: + +```shell +% ./bin/tps_darwin_arm64 list -f conversation-service +Using config file: /Users/Peter.Morton/.tps.yaml ++--------------------------------------------------------------------------------------------+-----------+----------------------+-------------------------+ +| PROPERTY NAME | VALUE | LAST MODIFIED BY | LAST MODIFIED DATE | ++--------------------------------------------------------------------------------------------+-----------+----------------------+-------------------------+ +| conversation-service.initialised | true | conversation-service | 2022-04-08T19:16:08.226 | +| conversation-service.upload.default.max-number-of-customer-attachments | 10 | conversation-service | 2022-04-08T19:16:08.197 | +| conversation-service.upload.default.max-number-of-customer-attachments-bytes | 100000000 | conversation-service | 2022-04-08T19:16:08.224 | +| conversation-service.upload.default.number-of-customer-attachments-bytes-period-in-minutes | 10 | conversation-service | 2022-04-08T19:16:08.22 | +| conversation-service.upload.default.number-of-customer-attachments-period-in-minutes | 10 | conversation-service | 2022-04-08T19:16:08.214 | ++--------------------------------------------------------------------------------------------+-----------+----------------------+-------------------------+ +``` + ## Building make