Skip to content

Commit 78d4661

Browse files
authored
docs: update README.md with AutoValue (#676)
I came to know the existing setting of AutoValue in this shared config pom.xml.
1 parent a8ac0f0 commit 78d4661

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# Google Cloud Shared Build Configs
22

33
Shared Maven build configuration for Google Cloud Java client libraries.
4+
This is not intended for library users.
45

56
[![Maven][maven-version-image]][maven-version-link]
67

@@ -26,6 +27,18 @@ This library follows [Semantic Versioning](http://semver.org/).
2627
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
2728
and the public API should not be considered stable.
2829

30+
## Usages
31+
32+
Declare this artifact as the parent of Maven projects of Google Cloud libraries.
33+
This brings useful Maven plugins and their configurations to the Maven projects,
34+
such as compilations, document generation, and library publication.
35+
36+
### AutoValue
37+
38+
If you want to use AutoValue in your project, place an empty file `EnableAutoValue.txt`
39+
in the module that requires AutoValue's annotation processing.
40+
Example pull request: https://github.com/googleapis/java-pubsub/pull/1761/files.
41+
2942
## Contributing
3043

3144
Contributions to this library are always welcome and highly encouraged.
@@ -44,4 +57,4 @@ Apache 2.0 - See [LICENSE][license] for more information.
4457
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-shared-config&core=gav
4558
[contributing]: https://github.com/googleapis/java-shared-config/blob/main/CONTRIBUTING.md
4659
[code-of-conduct]: https://github.com/googleapis/java-shared-config/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct
47-
[license]: https://github.com/googleapis/java-shared-config/blob/main/LICENSE
60+
[license]: https://github.com/googleapis/java-shared-config/blob/main/LICENSE

0 commit comments

Comments
 (0)