diff --git a/docs/README.md b/docs/README.md index 118dc34..22c0503 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -# Minio K8S bucket +# Minio K8S bucket operator An operator to automatically create and update S3 buckets on Minio, with their accounts. @@ -10,8 +10,8 @@ You will need: * `kubectl` access to the target cluster * A running Minio instance, and especially: - * The URL where the API of the instance can be reached - * The root credentials + * The URL where the API of the instance can be reached + * The root credentials ## Installation @@ -23,7 +23,7 @@ kubectl apply -f https://raw.githubusercontent.com/pierre42100/MinioK8sBuckets/m ``` !!! warning "Known limitation" - The operator install a deployment on the `default` namespace. Currently, only this namespace is supported! + The operator install a deployment on the `default` namespace. Currently, only this namespace is supported! ## Configure instance In order to create buckets, the operator needs to know how to reach the Minio instance. @@ -58,7 +58,7 @@ spec: ``` !!! note - Minio itself can be located outside of the Kubernetes cluster. + Minio itself can be located outside of the Kubernetes cluster. ## Create a bucket