Skip to content

Commit 06e02ca

Browse files
authored
Improve README (#373)
- Clarify distinction from the official samples - Add a contributing section
1 parent 182d89a commit 06e02ca

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,12 @@ api.buildsApi.getBuildsFlow(fromInstant = 0, query = "buildStartTime<-1d").forEa
1818
}
1919
```
2020

21-
The library takes care of caching under the hood (opt-in) and provides some convenience extensions.
21+
## How is this different from the [official samples][33]?
22+
23+
The official samples are an excellent demo of the API inside a full-fledged Java project.
24+
Among other things, you might not want to maintain an OpenAPI code generation setup.
25+
Even if you do, you'll find it generates less-than-ideal or even failing code depending on your `openapi-generator` configuration.
26+
This library [fixes][34] those issues in generated code, implements [paging][24], [caching][13] and [env-based configuration][8] for you, while providing a JAR that's ready-to-use from any project, script or notebook.
2227

2328
## Setup
2429

@@ -188,6 +193,12 @@ import com.gabrielfeo.develocity.api.model.*
188193
import com.gabrielfeo.develocity.api.model.extension.*
189194
```
190195

196+
## Issues and contributions
197+
198+
If you run into any problems, please open an issue to make it visible to maintainers and other users.
199+
Contributions are always welcome, although it's recommended to open an issue first.
200+
For general discussions or questions, feel free to reach out to maintainers on the [Gradle Community Slack][35].
201+
191202
[1]: https://docs.gradle.com/enterprise/api-manual/
192203
[2]: https://square.github.io/retrofit/
193204
[3]: https://github.com/square/retrofit/issues/3448
@@ -218,3 +229,6 @@ import com.gabrielfeo.develocity.api.model.extension.*
218229
[30]: https://kotlinlang.org/api/kotlinx.coroutines/kotlinx-coroutines-core/kotlinx.coroutines/run-blocking.html
219230
[31]: ./docs/AccessKeys.md
220231
[32]: ./examples
232+
[33]: https://github.com/gradle/develocity-api-samples
233+
[34]: https://github.com/gabrielfeo/develocity-api-kotlin/blob/main/build-logic/src/functionalTest/kotlin/com/gabrielfeo/task/PostProcessGeneratedApiTest.kt#L21
234+
[35]: https://community.gradle.org/#community-channels

0 commit comments

Comments
 (0)