Skip to content

docs: update README.md with AutoValue #676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 5, 2023
Merged

docs: update README.md with AutoValue #676

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
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