Skip to content

Commit a112275

Browse files
authored
Update README.md
1 parent 0b71db2 commit a112275

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,8 @@
22

33
A library for fetching, processing, and analyzing Develocity build data with a fluent API, built-in caching, and retry mechanisms.
44

5-
The library aims to simplify interactions with the `/api/builds/**` endpoints of the Develocity API by providing a high level API with proper typed classes for each build tool.
6-
When using this library, you'll focus less on how to interact with the Develocity API and more on the processing and analysis of build data.
7-
8-
Learn more about how to get started and leverage the full potential of Develocity and your build data below.
5+
The library aims to simplify working with the `/api/builds/**` endpoints from the Develocity API by providing a high level API with built-in convenience methods covering common use cases and proper typed classes for each build tool.
6+
When using this library, you'll focus more on the actual processing and analysis of build data and less on the underlying Develocity API.
97

108
## Getting started
119

@@ -55,8 +53,8 @@ A `BuildProcessor` works much like a Java `Stream` in that it has both *intermed
5553

5654
#### Intermediate operations
5755

58-
A `BuildProcessor` has several _intermediate operations_ used for the actual processing of data.
59-
There are several operators for use depending on your use case.
56+
A `BuildProcessor` has several _intermediate operations_ used for processing build data.
57+
There are several operators available to use depending on your use case.
6058

6159
```java
6260
// Print the ID of any build
@@ -91,9 +89,9 @@ processor.process(LocalDateTime.parse("2024-10-05T10:15:30"), "buildTool:gradle"
9189

9290
#### Build models
9391

94-
By default, the Develocity API returns a very limited amount of data about each build.
95-
To get more details, you need to define the *build models* to be returned.
96-
The more build models that are requested, the longer the query will take.
92+
By default, the Develocity API returns very limited data about each build.
93+
To get more details, you need to declare the *build models* you require.
94+
The more build models that are required, the longer the query will take.
9795

9896
This library works similarly.
9997
To use the additional data from the requested build models, cast the returned `Build` into a `BazelBuild`, `GradleBuild`, `MavenBuild`, or `SbtBuild`.
@@ -121,7 +119,7 @@ processor.onGradleBuild(gradleBuild -> {
121119
});
122120
```
123121

124-
Given requesting the *attributes* build models is so common, typically because this is the build model containing the custom values and tags, it's possible to query for these directly through the top-level `Build` object without casting.
122+
Given requesting the *attributes* build models is so common, it's possible to query for custom values, tags, and several other attributes shared between each build tool directly through the top-level `Build` object without casting.
125123

126124
```java
127125
processor.withRequiredBuildModels(GRADLE_ATTRIBUTES, MAVEN_ATTRIBUTES);

0 commit comments

Comments
 (0)