Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Updated docs to reference actually existing classes #219

Merged
merged 1 commit into from
Oct 24, 2023
Merged

docs: Updated docs to reference actually existing classes #219

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,7 +438,7 @@ The generated report will be available at ```target/site/jacoco/index.html```

## Configuration options

The `UnleashConfigBuilder` class (created via `UnleashConfig.builder()`) exposes a set of builder methods to configure your Unleash client. The available options are listed below with a description of what they do. For the full signatures, take a look at the [`UnleashConfig` class definition](src/main/java/io/getunleash/util/UnleashConfig.java).
The `UnleashConfig$Builder` class (created via `UnleashConfig.builder()`) exposes a set of builder methods to configure your Unleash client. The available options are listed below with a description of what they do. For the full signatures, take a look at the [`UnleashConfig` class definition](src/main/java/io/getunleash/util/UnleashConfig.java).


| Method name | Description | Required | Default value |
Expand Down Expand Up @@ -466,7 +466,7 @@ The `UnleashConfigBuilder` class (created via `UnleashConfig.builder()`) exposes
| `unleashAPI` | The URL of the Unleash API. | Yes | `null` |
| `unleashContextProvider` | An [Unleash context provider used to configure Unleash](#2-via-an-unleashcontextprovider). | No | `null` |
| `unleashFeatureFetcherFactory` | A factory providing a FeatureFetcher implementation. | No | [`HttpFeatureFetcher::new`](src/main/java/io/getunleash/repository/HttpFeatureFetcher.java) |
| `unleashMetricsSenderFactory` | A factory providing a MetricSender implementation. | No | [`JavaHttpMetricsSender::new`](src/main/java/io/getunleash/metric/JavaHttpMetricsSender.java) |
| `unleashMetricsSenderFactory` | A factory providing a MetricSender implementation. | No | [`DefaultHttpMetricsSender::new`](src/main/java/io/getunleash/metric/DefaultHttpMetricsSender.java) |

When you have set all the desired options, initialize the configuration with the `build` method.
You can then pass the configuration to the Unleash client constructor.
Expand Down