Merge pull request #1 from opencensus-beam/circleci

add circleci config and update readme

Author: tsloughter

.circleci/config.yml

@@ -0,0 +1,10 @@
+version: 2.1
+orbs:
+  rebar3: tsloughter/rebar3@0.5.4
+workflows:
+  build-test:
+    jobs:
+      - rebar3/compile
+      - rebar3/ct:
+          requires:
+            - rebar3/compile

README.md

@@ -1,9 +1,15 @@
-opencensus_zipkin
+OpenCensus Zipkin Reporter
 =====
 
-An OTP library
+[![CircleCI](https://circleci.com/gh/opencensus-beam/opencensus_zipkin.svg?style=svg)](https://circleci.com/gh/opencensus-beam/opencensus_zipkin)
+[![Hex.pm](https://img.shields.io/hexpm/v/opencensus_zipkin.svg?style=flat)](https://hex.pm/packages/opencensus_zipkin)
 
-Build
------
+To use, add `opencensus_zipkin` dependency as a runtime application (in rebar3 this means add to the `applications` list of `.app.src`) and set as the reporter in the `opencensus` configuration:
+
+``` erlang
+{opencensus, [
+    {reporter, {oc_reporter_zipkin, [{address, "http://localhost:9411/api/v2/spans"},
+                                     {local_endpoint, #{<<"serviceName">> => <<"service">>}]}}}
+    ...]}
+```
 
-    $ rebar3 compile

test/oc_reporter_zipkin_SUITE.erl

@@ -19,7 +19,9 @@ init_per_suite(Config) ->
     Config.
 
 end_per_suite(_Config) ->
+    ok = application:unload(opencensus),
     ok.
+
 init_per_testcase(zipkin_reporter, Config) ->
     application:set_env(opencensus, reporter, {oc_reporter_zipkin, [{address, "http://ct-host:9411/endpoint"},
                                                                     {local_endpoint,