Skip to content

Commit

Permalink
docs: update README.md with AutoValue
Browse files Browse the repository at this point in the history
  • Loading branch information
suztomo authored Oct 5, 2023
1 parent 778a547 commit a868f5b
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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]

Expand All @@ -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.
Expand All @@ -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
[license]: https://github.com/googleapis/java-shared-config/blob/main/LICENSE

0 comments on commit a868f5b

Please sign in to comment.