aboutsummaryrefslogtreecommitdiff
path: root/contrib/appengine_standard_util/README.md
diff options
context:
space:
mode:
authorBogdan Drutu <bdrutu@google.com>2018-05-30 16:32:34 -0700
committerGitHub <noreply@github.com>2018-05-30 16:32:34 -0700
commit709d97aa321d5729988fd63b960bbece04cfba10 (patch)
tree76813530fd470288ed572563ce0157f680a216f0 /contrib/appengine_standard_util/README.md
parenta2674ef541d6e8a373d0d33c673be3da3ee039e0 (diff)
downloadopencensus-java-709d97aa321d5729988fd63b960bbece04cfba10.tar.gz
Add util contrib package for AppEngine standard. (#1214)
Diffstat (limited to 'contrib/appengine_standard_util/README.md')
-rw-r--r--contrib/appengine_standard_util/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/contrib/appengine_standard_util/README.md b/contrib/appengine_standard_util/README.md
new file mode 100644
index 00000000..ba1a4871
--- /dev/null
+++ b/contrib/appengine_standard_util/README.md
@@ -0,0 +1,35 @@
+# OpenCensus AppEngine Standard Util
+[![Build Status][travis-image]][travis-url]
+[![Windows Build Status][appveyor-image]][appveyor-url]
+[![Maven Central][maven-image]][maven-url]
+
+The *OpenCensus AppEngine Standard Util for Java* is a collection of utilities for trace
+instrumentation when working with [AppEngine][appengine-url].
+
+## Quickstart
+
+### Add the dependencies to your project
+
+For Maven add to your `pom.xml`:
+```xml
+<dependencies>
+ <dependency>
+ <groupId>io.opencensus</groupId>
+ <artifactId>opencensus-appengine-standard-util</artifactId>
+ <version>0.14.0</version>
+ </dependency>
+</dependencies>
+```
+
+For Gradle add to your dependencies:
+```gradle
+compile 'io.opencensus:opencensus-contrib-appengine-standard-util:0.14.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/opencensusjavateam/opencensus-java/branch/master
+[maven-image]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-appengine-standard-util/badge.svg
+[maven-url]: https://maven-badges.herokuapp.com/maven-central/io.opencensus/opencensus-contrib-appengine-standard-util
+[appengine-url]: https://appengine.google.com/