aboutsummaryrefslogtreecommitdiffstats
path: root/contrib/grpc_util/README.md
diff options
context:
space:
mode:
authorBogdan Drutu <bdrutu@google.com>2017-09-05 10:40:42 -0700
committerGitHub <noreply@github.com>2017-09-05 10:40:42 -0700
commit8781dbbf947d7cb8aa65043e8dfe6447f1f0dbf6 (patch)
treeacbc31fbfe0cf5241a2cc63c1dc5d529cf82e8c1 /contrib/grpc_util/README.md
parent8b19f6e3a6cf88ee2661df86e2415cea8fee0609 (diff)
downloadplatform_external_opencensus-java-8781dbbf947d7cb8aa65043e8dfe6447f1f0dbf6.tar.gz
platform_external_opencensus-java-8781dbbf947d7cb8aa65043e8dfe6447f1f0dbf6.tar.bz2
platform_external_opencensus-java-8781dbbf947d7cb8aa65043e8dfe6447f1f0dbf6.zip
Add a new artifact for gRPC utility classes for instrumentation. (#577)
* Add a new artifact for gRPC utility classes for instrumentation. * Add code conversion and fix readme. * Enable exporting to maven for grpc_util. * Use Code for gRPC not CanonicalCode.
Diffstat (limited to 'contrib/grpc_util/README.md')
-rw-r--r--contrib/grpc_util/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/contrib/grpc_util/README.md b/contrib/grpc_util/README.md
new file mode 100644
index 00000000..8880ef28
--- /dev/null
+++ b/contrib/grpc_util/README.md
@@ -0,0 +1,33 @@
+# OpenCensus gRPC Util
+[![Build Status][travis-image]][travis-url] [![Build status][appveyor-image]][appveyor-url] [![Maven Central][maven-image]][maven-url]
+
+The *OpenCensus gRPC Util for Java* is a collection of utilities for trace instrumentation when
+working with [gRPC][grpc-url].
+
+## Quickstart
+
+### Add the dependencies to your project
+
+For Maven add to your `pom.xml`:
+```xml
+<dependencies>
+ <dependency>
+ <groupId>io.opencensus</groupId>
+ <artifactId>opencensus-contrib-grpc-util</artifactId>
+ <version>0.6.0</version>
+ </dependency>
+</dependencies>
+```
+
+For Gradle add to your dependencies:
+```gradle
+compile 'io.opencensus:opencensus-contrib-grpc-util:0.6.0'
+```
+
+[travis-image]: https://travis-ci.org/census-instrumentation/opencensus-java.svg?branch=master
+[travis-url]: https://travis-ci.org/census-instrumentation/opencensus-java
+[appveyor-image]: https://ci.appveyor.com/api/projects/status/hxthmpkxar4jq4be/branch/master?svg=true
+[appveyor-url]: https://ci.appveyor.com/project/instrumentationjavateam/opencensus-java/branch/master
+[maven-image]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-grpc-util/badge.svg
+[maven-url]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-grpc-util
+[grpc-url]: https://github.com/grpc/grpc-java