Skip to content

READMEs: clarifying umbrella package #2806

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
garrettjonesgoogle merged 2 commits into from
Jan 24, 2018
Merged

READMEs: clarifying umbrella package #2806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4393dc2
READMEs: clarifying umbrella package
garrettjonesgoogle Jan 24, 2018
8046711
Fixing link to main README
garrettjonesgoogle Jan 24, 2018
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
25 changes: 16 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ Java idiomatic client for [Google Cloud Platform][cloud-platform] services.
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
[![Dependency Status](https://www.versioneye.com/user/projects/58fe4c8d6ac171426c414772/badge.svg?style=flat)](https://www.versioneye.com/user/projects/58fe4c8d6ac171426c414772)

- [Homepage](https://googlecloudplatform.github.io/google-cloud-java/)
- [API Documentation](https://googlecloudplatform.github.io/google-cloud-java/apidocs)
- [Google Cloud Platform Documentation][cloud-platform-docs]
- [Client Library Documentation][client-lib-docs]

This library supports the following Google Cloud Platform services with clients at a [GA](#versioning) quality level:
- [Stackdriver Logging](google-cloud-logging) (GA)
Expand Down Expand Up @@ -42,29 +42,33 @@ This library supports the following Google Cloud Platform services with clients
- [Cloud Speech](google-cloud-speech) (Alpha)
- [Dialogflow](google-cloud-dialogflow) (Alpha)

> Note: google-cloud-java is a work-in-progress, and may occasionally
> make backwards-incompatible changes.

Quickstart
----------

The easy way to get started is to add the umbrella package which pulls in all of the supported clients as
dependencies. Note that even though the version of the umbrella package is Alpha, the individual clients are
at different support levels (Alpha, Beta, and GA).

If you are using Maven, add this to your pom.xml file
```xml
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud</artifactId>
<version>0.32.0-alpha</version>
<version>0.33.0-alpha</version>
</dependency>
```
If you are using Gradle, add this to your dependencies
```Groovy
compile 'com.google.cloud:google-cloud:0.32.0-alpha'
compile 'com.google.cloud:google-cloud:0.33.0-alpha'
```
If you are using SBT, add this to your dependencies
```Scala
libraryDependencies += "com.google.cloud" % "google-cloud" % "0.32.0-alpha"
libraryDependencies += "com.google.cloud" % "google-cloud" % "0.33.0-alpha"
```

It also works just as well to declare a dependency only on the specific clients that you need. See the README of
each client for instructions.

For running on Google App Engine, see [more instructions here](./APPENGINE.md).

If you are running into problems with version conflicts, see [Version Management](#version-management).
Expand Down Expand Up @@ -274,7 +278,7 @@ The easiest way to solve version conflicts is to use google-cloud's BOM. In Mave
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-bom</artifactId>
<version>0.32.0-alpha</version>
<version>0.33.0-alpha</version>
<type>pom</type>
<scope>import</scope>
</dependency>
Expand Down Expand Up @@ -337,4 +341,7 @@ Apache 2.0 - See [LICENSE] for more information.
[code-of-conduct]:https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[LICENSE]: https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/LICENSE
[TESTING]: https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/TESTING.md

[cloud-platform]: https://cloud.google.com/
[cloud-platform-docs]: https://cloud.google.com/docs/
[client-lib-docs]: http://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/
34 changes: 9 additions & 25 deletions google-cloud/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
Google Cloud Java Client
==========================
Google Cloud Java (All API Clients)
===================================

Java idiomatic client for [Google Cloud Platform][cloud-platform] services.
Umbrella package that declares a dependency on all currently-available Java clients for [Google Cloud Platform][cloud-platform] services.

[![Build Status](https://travis-ci.org/GoogleCloudPlatform/google-cloud-java.svg?branch=master)](https://travis-ci.org/GoogleCloudPlatform/google-cloud-java)
[![Coverage Status](https://coveralls.io/repos/GoogleCloudPlatform/google-cloud-java/badge.svg?branch=master)](https://coveralls.io/r/GoogleCloudPlatform/google-cloud-java?branch=master)
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-core.svg)]( https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-core.svg)
[![Maven](https://img.shields.io/maven-central/v/com.google.cloud/google-cloud.svg)]( https://img.shields.io/maven-central/v/com.google.cloud/google-cloud.svg)
[![Codacy Badge](https://api.codacy.com/project/badge/grade/9da006ad7c3a4fe1abd142e77c003917)](https://www.codacy.com/app/mziccard/google-cloud-java)
[![Dependency Status](https://www.versioneye.com/user/projects/58fe4c8d6ac171426c414772/badge.svg?style=flat)](https://www.versioneye.com/user/projects/58fe4c8d6ac171426c414772)

- [Homepage](https://googlecloudplatform.github.io/google-cloud-java/)
- [API Documentation](http://googlecloudplatform.github.io/google-cloud-java/apidocs)
- See the [root README of google-cloud-java](https://github.com/GoogleCloudPlatform/google-cloud-java) for more details
on which clients are alpha, beta, and GA.

This client supports the following Google Cloud Platform services:

- [Google Cloud Datastore](https://cloud.google.com/datastore/) [datastore documentation][datastore-api]
- [Google Cloud Storage](https://cloud.google.com/storage/) [storage documentation][storage-api]

> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.
> Note: This package does not have guaranteed stability and may experience backwards-incompatible changes.
> This does not imply anything about the stability of the packages it depends on (i.e. the individual API client
> libraries), only that particular dependencies may be added or removed.

Quickstart
----------
Expand Down Expand Up @@ -77,15 +73,3 @@ Apache 2.0 - See [LICENSE] for more information.
[code-of-conduct]:https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/CODE_OF_CONDUCT.md#contributor-code-of-conduct
[LICENSE]: https://github.com/GoogleCloudPlatform/google-cloud-java/blob/master/LICENSE
[cloud-platform]: https://cloud.google.com/
[cloud-datastore]: https://cloud.google.com/datastore/docs
[cloud-datastore-docs]: https://cloud.google.com/datastore/docs
[cloud-datastore-activation]: https://cloud.google.com/datastore/docs/activate
[datastore-api]: https://googlecloudplatform.github.io/google-cloud-java/apidocs/index.html?com/google/cloud/datastore/package-summary.html

[cloud-pubsub]: https://cloud.google.com/pubsub/
[cloud-pubsub-docs]: https://cloud.google.com/pubsub/docs

[cloud-storage]: https://cloud.google.com/storage/
[cloud-storage-docs]: https://cloud.google.com/storage/docs/overview
[cloud-storage-create-bucket]: https://cloud.google.com/storage/docs/cloud-console#_creatingbuckets
[storage-api]: https://googlecloudplatform.github.io/google-cloud-java/apidocs/index.html?com/google/cloud/storage/package-summary.html