Skip to content

Commit

Permalink
chore: regenerate README
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-automation committed Oct 15, 2020
1 parent 3213d37 commit a5f503b
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 14 deletions.
18 changes: 18 additions & 0 deletions .github/readme/synth.metadata/synth.metadata
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
{
"sources": [
{
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-shared-config.git",
"sha": "3213d373bd9059907158b41ec4b9f0aacc80d242"
}
},
{
"git": {
"name": "synthtool",
"remote": "https://github.com/googleapis/synthtool.git",
"sha": "27e0e916cbfdb3d5ff6639b686cc04f78a0b0386"
}
}
]
}
117 changes: 103 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,93 @@
# Google Cloud Shared Build Configs
# Google Google Cloud Shared Build Configs Client for Java

Shared Maven build configuration for Google Cloud Java client libraries.
Java idiomatic client for [Google Cloud Shared Build Configs][product-docs].

[![Maven][maven-version-image]][maven-version-link]
![Stability][stability-image]

- [Product Documentation][product-docs]
- [Client Library Documentation][javadocs]

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.
## Quickstart

[//]: # ({x-version-update-start:google-cloud-shared-config:released})
If you are using Maven, use this artifact as your project's parent.

If you are using Maven, add this to your pom.xml file:

```xml
<project>
<parent>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-shared-config</artifactId>
<version>0.9.2</version>
</parent>
</project>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-shared-config</artifactId>
<version>0.9.2</version>
</dependency>
```
[//]: # ({x-version-update-end})

If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud-shared-config:0.9.2'
```
If you are using SBT, add this to your dependencies
```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-shared-config" % "0.9.2"
```

## Authentication

See the [Authentication][authentication] section in the base directory's README.

## Getting Started

### Prerequisites

You will need a [Google Cloud Platform Console][developer-console] project with the Google Cloud Shared Build Configs [API enabled][enable-api].

[Follow these instructions][create-project] to get your project set up. You will also need to set up the local development environment by
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.

### Installation and setup

You'll need to obtain the `google-cloud-shared-config` library. See the [Quickstart](#quickstart) section
to add `google-cloud-shared-config` as a dependency in your code.

## About Google Cloud Shared Build Configs


[Google Cloud Shared Build Configs][product-docs]

See the [Google Cloud Shared Build Configs client library docs][javadocs] to learn how to
use this Google Cloud Shared Build Configs Client Library.






## Troubleshooting

To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].

## Java Versions

Java 7 or above is required for using this client.

## Versioning


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.

## Contributing


Contributions to this library are always welcome and highly encouraged.

See [CONTRIBUTING.md][contributing] documentation for more information on how to get started.
See [CONTRIBUTING][contributing] for more information how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
Expand All @@ -40,8 +97,40 @@ information.

Apache 2.0 - See [LICENSE][license] for more information.

## CI Status

Java Version | Status
------------ | ------
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]

[product-docs]:
[javadocs]:
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java7.svg
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java7.html
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java8.svg
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java8.html
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java8-osx.svg
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java8-osx.html
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java8-win.svg
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java8-win.html
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java11.svg
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-shared-config/java11.html
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-shared-config.svg
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-shared-config&core=gav
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
[developer-console]: https://console.developers.google.com/
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
[cloud-sdk]: https://cloud.google.com/sdk/
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
[contributing]: https://github.com/googleapis/java-shared-config/blob/master/CONTRIBUTING.md
[code-of-conduct]: https://github.com/googleapis/java-shared-config/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[license]: https://github.com/googleapis/java-shared-config/blob/master/LICENSE
[license]: https://github.com/googleapis/java-shared-config/blob/master/LICENSE


[libraries-bom]: https://github.com/GoogleCloudPlatform/cloud-opensource-java/wiki/The-Google-Cloud-Platform-Libraries-BOM
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png

0 comments on commit a5f503b

Please sign in to comment.