Skip to content
This repository was archived by the owner on Sep 16, 2023. It is now read-only.

Commit 645d387

Browse files
chingor13chingor13
authored
docs: add stability image (#10)
* docs: add stability badge, fix kokoro badge * docs: fix library name * docs: make Kokoro badges into a table * docs: remove top Kokoro badge
1 parent de1e274 commit 645d387

File tree

2 files changed

+81
-53
lines changed

2 files changed

+81
-53
lines changed

‎.repo-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "automl",
3-
"name_pretty": "AutoML",
3+
"name_pretty": "Cloud Auto ML",
44
"product_documentation": "https://cloud.google.com/automl/docs/",
55
"client_documentation": "https://googleapis.dev/java/java-automl/latest/index.html",
66
"issue_tracker": "https://issuetracker.google.com/savedsearches/559744",

‎README.md

Lines changed: 80 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,19 @@
1-
Google Cloud Java Client for Cloud Auto ML
2-
===================================================
1+
# Google Cloud Java Client for Cloud Auto ML
32

4-
Java idiomatic client for [Cloud Auto ML][cloud-automl].
3+
Java idiomatic client for [Cloud Auto ML][api-reference].
54

6-
[![Kokoro CI](http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/master.svg)](http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/master.html)
7-
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-automl.svg)](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-automl.svg)
5+
[![Maven][maven-version-image]][maven-version-link]
6+
![Stability][stability-image]
87

9-
- [Product Documentation][automl-product-docs]
10-
- [Client Library Documentation][automl-client-lib-docs]
8+
- [Product Documentation][product-docs]
9+
- [Client Library Documentation][javadocs]
1110

1211
> Note: This client is a work-in-progress, and may occasionally
1312
> make backwards-incompatible changes.
1413
15-
Quickstart
16-
----------
14+
## Quickstart
1715

18-
[//]: # ({x-version-update-start:google-cloud-automl:released})
16+
[//]: # ({x-version-update-start:automl:released})
1917
If you are using Maven, add this to your pom.xml file
2018
```xml
2119
<dependency>
@@ -34,66 +32,96 @@ libraryDependencies += "com.google.cloud" % "google-cloud-automl" % "0.111.0-bet
3432
```
3533
[//]: # ({x-version-update-end})
3634

37-
Authentication
38-
--------------
35+
## Authentication
3936

40-
See the [Authentication](https://github.com/googleapis/google-cloud-java#authentication) section in the base directory's README.
37+
See the [Authentication][authentication] section in the base directory's README.
4138

42-
About Cloud Auto ML
43-
----------------------------
39+
## About Cloud Auto ML
4440

45-
[Cloud Auto ML][cloud-automl] is a suite of Machine Learning products.
41+
[Cloud Auto ML][api-reference] is a suite of Machine Learning products.
4642

47-
See the [Cloud Auto ML client library docs][automl-client-lib-docs] to learn how to use this Cloud Auto ML Client Library.
43+
See the [Cloud Auto ML client library docs][javadocs] to learn how to
44+
use this Cloud Auto ML Client Library.
4845

49-
Getting Started
50-
---------------
51-
#### Prerequisites
52-
You will need a [Google Developers Console](https://console.developers.google.com/) project with the Cloud Auto ML API enabled. [Follow these instructions](https://cloud.google.com/resource-manager/docs/creating-managing-projects) to get your project set up. You will also need to set up the local development environment by [installing the Google Cloud SDK](https://cloud.google.com/sdk/) and running the following commands in command line: `gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
46+
## Getting Started
5347

54-
#### Installation and setup
55-
You'll need to obtain the `google-cloud-automl` library. See the [Quickstart](#quickstart) section to add `google-cloud-automl` as a dependency in your code.
48+
### Prerequisites
5649

57-
Troubleshooting
58-
---------------
50+
You will need a [Google Developers Console][developer-console] project with the
51+
Cloud Auto ML API enabled. [Follow these instructions][create-project] to get your
52+
project set up. You will also need to set up the local development environment by
53+
[installing the Google Cloud SDK][cloud-sdk] and running the following commands in command line:
54+
`gcloud auth login` and `gcloud config set project [YOUR PROJECT ID]`.
5955

60-
To get help, follow the instructions in the [shared Troubleshooting document](https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting).
56+
### Installation and setup
6157

62-
Transport
63-
---------
64-
Cloud Auto ML uses gRPC for the transport layer.
58+
You'll need to obtain the `google-cloud-automl` library. See the [Quickstart](#quickstart) section
59+
to add `google-cloud-automl` as a dependency in your code.
6560

66-
Java Versions
67-
-------------
61+
## Troubleshooting
6862

69-
Java 7 or above is required for using this client.
63+
To get help, follow the instructions in the [shared Troubleshooting document][troubleshooting].
7064

71-
Versioning
72-
----------
65+
## Transport
7366

74-
This library follows [Semantic Versioning](http://semver.org/).
75-
76-
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.
67+
Cloud Auto ML uses gRPC for the transport layer.
7768

78-
Contributing
79-
------------
69+
## Java Versions
8070

81-
Contributions to this library are always welcome and highly encouraged.
71+
Java 7 or above is required for using this client.
8272

83-
See `google-cloud`'s [CONTRIBUTING] documentation and the [shared documentation](https://github.com/googleapis/google-cloud-common/blob/master/contributing/readme.md#how-to-contribute-to-gcloud) for more information on how to get started.
73+
## Versioning
8474

85-
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 information.
75+
This library follows [Semantic Versioning](http://semver.org/).
8676

87-
License
88-
-------
77+
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
78+
and the public API should not be considered stable.
8979

90-
Apache 2.0 - See [LICENSE] for more information.
80+
## Contributing
9181

82+
Contributions to this library are always welcome and highly encouraged.
9283

93-
[CONTRIBUTING]:https://github.com/googleapis/java-automl/blob/master/CONTRIBUTING.md
94-
[code-of-conduct]:https://github.com/googleapis/java-automl/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
95-
[LICENSE]: https://github.com/googleapis/java-automl/blob/master/LICENSE
96-
[cloud-platform]: https://cloud.google.com/
97-
[cloud-automl]: https://cloud.google.com/automl
98-
[automl-product-docs]: https://cloud.google.com/automl/
99-
[automl-client-lib-docs]: https://googleapis.dev/java/java-automl/latest/index.html
84+
See [CONTRIBUTING.md][contributing] documentation for more information on how to get started.
85+
86+
Please note that this project is released with a Contributor Code of Conduct. By participating in
87+
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
88+
information.
89+
90+
## License
91+
92+
Apache 2.0 - See [LICENSE][license] for more information.
93+
94+
## CI Status
95+
96+
Java Version | Status
97+
------------ | ------
98+
Java 7 | [![Kokoro CI][kokoro-badge-image-1]][kokoro-badge-link-1]
99+
Java 8 | [![Kokoro CI][kokoro-badge-image-2]][kokoro-badge-link-2]
100+
Java 8 OSX | [![Kokoro CI][kokoro-badge-image-3]][kokoro-badge-link-3]
101+
Java 8 Windows | [![Kokoro CI][kokoro-badge-image-4]][kokoro-badge-link-4]
102+
Java 11 | [![Kokoro CI][kokoro-badge-image-5]][kokoro-badge-link-5]
103+
104+
[api-reference]: https://cloud.google.com/automl/
105+
[product-docs]: https://cloud.google.com/automl/docs/
106+
[javadocs]: https://googleapis.dev/java/java-automl/latest/index.html
107+
[kokoro-badge-image-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java7.svg
108+
[kokoro-badge-link-1]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java7.html
109+
[kokoro-badge-image-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8.svg
110+
[kokoro-badge-link-2]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8.html
111+
[kokoro-badge-image-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8-osx.svg
112+
[kokoro-badge-link-3]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8-osx.html
113+
[kokoro-badge-image-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8-win.svg
114+
[kokoro-badge-link-4]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java8-win.html
115+
[kokoro-badge-image-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java11.svg
116+
[kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-automl/java11.html
117+
[stability-image]: https://img.shields.io/badge/stability-beta-yellow
118+
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-automl.svg
119+
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-automl&core=gav
120+
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
121+
[developer-console]: https://console.developers.google.com/
122+
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
123+
[cloud-sdk]: https://cloud.google.com/sdk/
124+
[troubleshooting]: https://github.com/googleapis/google-cloud-common/blob/master/troubleshooting/readme.md#troubleshooting
125+
[contributing]: https://github.com/googleapis/java-automl/blob/master/CONTRIBUTING.md
126+
[code-of-conduct]: https://github.com/googleapis/java-automl/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
127+
[license]: https://github.com/googleapis/java-automl/blob/master/LICENSE

0 commit comments

Comments
 (0)