README.md updated for comments

This commit is contained in:
Erkan Ozsoy
2023-07-03 17:03:45 +03:00
parent 5aa726f723
commit b24255db5e
2 changed files with 14 additions and 4 deletions

View File

@@ -7,11 +7,16 @@ import (
// Config defines the config for storage.
type Config struct {
Endpoints []string
// Endpoints is a list of URLs.
Endpoints []string
// DialTimeout is the timeout for failing to establish a connection.
DialTimeout time.Duration
Username string
Password string
Context context.Context
// Username is a username for authentication.
Username string
// Password is a password for authentication.
Password string
// Context is the context for the client.
Context context.Context
}
// ConfigDefault is the default config