Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
Signed-off-by: Vanshikav123 <vanshikav928@gmail.com>
  • Loading branch information
Vanshikav123 committed May 31, 2024
1 parent 540c1e5 commit 1b2aa76
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Generally, you have two ways of using `objstore` module:
First is to import the provider you want e.g. [`github.com/thanos-io/objstore/providers/s3`](providers/s3) and instantiate it with available constructor (e.g. `NewBucket`).
The second option is to use the factory `NewBucket(logger log.Logger, confContentYaml []byte, reg prometheus.Registerer, component string,rt http.RoundTripper)` that will instantiate the object storage client based on YAML file provided. The YAML file has generally the format like this:
The second option is to use the factory `NewBucket(logger log.Logger, confContentYaml []byte, reg prometheus.Registerer, component string, rt http.RoundTripper)` that will instantiate the object storage client based on YAML file provided. The YAML file has generally the format like this:
```yaml
type: <PROVIDER_TYPE>
Expand All @@ -114,7 +114,7 @@ config:
The exact option depends on provider and are in sections below.
`NewBucket` function now accepts an `http.RoundTripper` parameter allows clients to provide a custom transport for HTTP requests, making the function more flexible , this change facilitates the use of various HTTP client configurations, including hedged HTTP transports.
`NewBucket` function now accepts an `http.RoundTripper` parameter allows clients to provide a custom transport for HTTP requests. This change allows the use of various HTTP clients, including hedged HTTP transports.
> NOTE: All code snippets are auto-generated from code and up-to-date.
Expand Down

0 comments on commit 1b2aa76

Please sign in to comment.