diff --git a/README.md b/README.md index 3e2bef13..9dc747a4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Google Cloud Shared Build Configs Shared Maven build configuration for Google Cloud Java client libraries. +This is not intended for library users. [![Maven][maven-version-image]][maven-version-link] @@ -26,6 +27,18 @@ This library follows [Semantic Versioning](http://semver.org/). It is currently in major version zero (``0.y.z``), which means that anything may change at any time and the public API should not be considered stable. +## Usages + +Declare this artifact as the parent of Maven projects of Google Cloud libraries. +This brings useful Maven plugins and their configurations to the Maven projects, +such as compilations, document generation, and library publication. + +### AutoValue + +If you want to use AutoValue in your project, place an empty file `EnableAutoValue.txt` +in the module that requires AutoValue's annotation processing. +Example pull request: https://github.com/googleapis/java-pubsub/pull/1761/files. + ## Contributing Contributions to this library are always welcome and highly encouraged. @@ -44,4 +57,4 @@ Apache 2.0 - See [LICENSE][license] for more information. [maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-shared-config&core=gav [contributing]: https://github.com/googleapis/java-shared-config/blob/main/CONTRIBUTING.md [code-of-conduct]: https://github.com/googleapis/java-shared-config/blob/main/CODE_OF_CONDUCT.md#contributor-code-of-conduct -[license]: https://github.com/googleapis/java-shared-config/blob/main/LICENSE \ No newline at end of file +[license]: https://github.com/googleapis/java-shared-config/blob/main/LICENSE