From 9406f59de8ba48856464dc9c044f07a274babdfd Mon Sep 17 00:00:00 2001 From: guicamest Date: Tue, 17 Oct 2023 17:46:08 +0200 Subject: [PATCH] chore(README): Format local/system parameters as table (#211) --- README.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 8f301b05..a727ed29 100644 --- a/README.md +++ b/README.md @@ -133,23 +133,24 @@ If no configuration is supplied the values in `resources/s3-nio-spi.properties` Each fragment is downloaded concurrently on a unique thread. #### Local parameters -**aws.region** specifies the default region for API calls -**aws.accessKey** specifies the key id to use for authentication -**aws.secretAccessKey** specifies the secret to use for authentication - -**s3.spi.read.fragment-number** buffer asynchronously prefetches `n` sequential fragments from S3 (currently 50) -**s3.spi.read.fragment-size** size of each fragment (currently 5MB) -**s3.spi.endpoint** the endpoint to use to access the bucket; this is extracted from the uri by the S3X provider -**s3.spi.force-path-style** (true|false) to set if path-style shall be used instead of host style; unless otherwise -specified, this is undefined for the S3 provider and set to true when using the S3X provider. +|parameter|description| +|---------|-----------| +|**aws.region**|specifies the default region for API calls| +|**aws.accessKey**|specifies the key id to use for authentication| +|**aws.secretAccessKey**|specifies the secret to use for authentication| +|**s3.spi.read.fragment-number**|buffer asynchronously prefetches `n` sequential fragments from S3 (currently 50)| +|**s3.spi.read.fragment-size**|size of each fragment (currently 5MB)| +|**s3.spi.endpoint**|the endpoint to use to access the bucket; this is extracted from the uri by the S3X provider| +|**s3.spi.force-path-style**|(true\|false) to set if path-style shall be used instead of host style; unless otherwise specified, this is undefined for the S3 provider and set to true when using the S3X provider.| #### System parameter #### -**aws.region** specifies the default region for API calls -**aws.accessKey** specifies the key id to use for authentication -**aws.secretAccessKey** specifies the secret to use for authentication - -**s3.spi.read.fragment-number** buffer asynchronously prefetches `n` sequential fragments from S3 (currently 50) -**s3.spi.read.fragment-size** size of each fragment (currently 5MB) +|parameter|description| +|---------|-----------| +|**aws.region**|specifies the default region for API calls| +|**aws.accessKey**|specifies the key id to use for authentication| +|**aws.secretAccessKey**|specifies the secret to use for authentication| +|**s3.spi.read.fragment-number**|buffer asynchronously prefetches `n` sequential fragments from S3 (currently 50)| +|**s3.spi.read.fragment-size**|size of each fragment (currently 5MB)| #### Environment Variables