|
| 1 | +Google Cloud Java Client for Pub/Sub |
| 2 | +==================================== |
| 3 | + |
| 4 | +Java idiomatic client for [Google Cloud Pub/Sub] (https://cloud.google.com/pubsub/). |
| 5 | + |
| 6 | +[](https://travis-ci.org/GoogleCloudPlatform/gcloud-java) |
| 7 | +[](https://coveralls.io/r/GoogleCloudPlatform/gcloud-java?branch=master) |
| 8 | +[]( https://img.shields.io/maven-central/v/com.google.gcloud/gcloud-java-pubsub.svg) |
| 9 | + |
| 10 | +- [Homepage] (https://googlecloudplatform.github.io/gcloud-java/) |
| 11 | +- [API Documentation] (http://googlecloudplatform.github.io/gcloud-java/apidocs) |
| 12 | + |
| 13 | +> Note: This client is a work-in-progress, and may occasionally |
| 14 | +> make backwards-incompatible changes. |
| 15 | +
|
| 16 | +Quickstart |
| 17 | +---------- |
| 18 | +Add this to your pom.xml file |
| 19 | +```xml |
| 20 | +<dependency> |
| 21 | + <groupId>com.google.gcloud</groupId> |
| 22 | + <artifactId>gcloud-java-pubsub</artifactId> |
| 23 | + <version>0.0.10</version> |
| 24 | +</dependency> |
| 25 | +``` |
| 26 | + |
| 27 | +Example Application |
| 28 | +------------------- |
| 29 | +TODO |
| 30 | + |
| 31 | +Authentication |
| 32 | +-------------- |
| 33 | + |
| 34 | +See the [Authentication](https://github.com/GoogleCloudPlatform/gcloud-java#authentication) section in the base directory's README. |
| 35 | + |
| 36 | +About Google Cloud Pub/Sub |
| 37 | +-------------------------- |
| 38 | + |
| 39 | +[Google Cloud Pub/Sub][cloud-pubsub] is designed to provide reliable, |
| 40 | +many-to-many, asynchronous messaging between applications. Publisher |
| 41 | +applications can send messages to a ``topic`` and other applications can |
| 42 | +subscribe to that topic to receive the messages. By decoupling senders and |
| 43 | +receivers, Google Cloud Pub/Sub allows developers to communicate between |
| 44 | +independently written applications. |
| 45 | + |
| 46 | +TODO: link to docs on activating Pub/Sub, high-level documentation on |
| 47 | +the API, and code snippet |
| 48 | + |
| 49 | +Java Versions |
| 50 | +------------- |
| 51 | + |
| 52 | +Java 7 or above is required for using this client. |
| 53 | + |
| 54 | +Testing |
| 55 | +------- |
| 56 | + |
| 57 | +TODO |
| 58 | + |
| 59 | +Versioning |
| 60 | +---------- |
| 61 | + |
| 62 | +This library follows [Semantic Versioning] (http://semver.org/). |
| 63 | + |
| 64 | +It is currently in major version zero (``0.y.z``), which means that anything |
| 65 | +may change at any time and the public API should not be considered |
| 66 | +stable. |
| 67 | + |
| 68 | +Contributing |
| 69 | +------------ |
| 70 | + |
| 71 | +Contributions to this library are always welcome and highly encouraged. |
| 72 | + |
| 73 | +See [CONTRIBUTING] for more information on how to get started. |
| 74 | + |
| 75 | +License |
| 76 | +------- |
| 77 | + |
| 78 | +Apache 2.0 - See [LICENSE] for more information. |
| 79 | + |
| 80 | + |
| 81 | +[CONTRIBUTING]:https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/CONTRIBUTING.md |
| 82 | +[LICENSE]: https://github.com/GoogleCloudPlatform/gcloud-java/blob/master/LICENSE |
| 83 | + |
| 84 | +[cloud-pubsub]: https://cloud.google.com/storage/ |
0 commit comments