zipkin in readme (#33)

Author: SergeyKanzhelev

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "rewrap.wrappingColumn": 79
+}

CHANGELOG.md

@@ -1,4 +1,5 @@
 # Unreleased
 
-- Initial version of SDK published. It is based on contribution from Pivotal from https://github.com/SteeltoeOSS/Management/tree/dev/src/Steeltoe.Management.OpenCensus
-
+- Zipkin exporter implemented.
+- Initial version of SDK published. It is based on contribution from Pivotal
+  [from](https://github.com/SteeltoeOSS/Management/tree/dev/src/Steeltoe.Management.OpenCensus).

CONTRIBUTING.md

@@ -1,42 +1,50 @@
-# Report a bug
+# Contributing
+
+## Report a bug or requesting feature
 
 Reporting bug is an important contribution. Please make sure to include:
 
 - expected and actual behavior.
-- dotnet version that application is compiled on and running with (it may be different - for instance target framework was set to .NET 4.6 for compilaiton, but applicaiton is running on .NET 4.7.3).
+- dotnet version that application is compiled on and running with (it may be
+  different - for instance target framework was set to .NET 4.6 for
+  compilaiton, but applicaiton is running on .NET 4.7.3).
 - exception call stack and other artifacts.
 - if possible - reporo application and steps to reproduce.
 
-# How to contribute
+## How to contribute
 
-## Before started
+### Before started
 
-In order to protect both you and ourselves, you will need to sign the [Contributor License Agreement](https://cla.developers.google.com/clas).
+In order to protect both you and ourselves, you will need to sign the
+[Contributor License Agreement](https://cla.developers.google.com/clas).
 
-## Build
+### Build
 
-You can use Visual Studio 2017 or VS code to contribute. Just open root folder or `OpenCensus.sln` in your editor and follow normal development process.
+You can use Visual Studio 2017 or VS code to contribute. Just open root folder
+or `OpenCensus.sln` in your editor and follow normal development process.
 
 To build from command line you need `dotnet` version `2.0+`.
 
-```
+``` sh
 dotnet build OpenCensus.sln
 ```
 
-## Test
+### Test
 
-You can use Visual Studio 2017 or VS code to test your contribution. Open root folder or `OpenCensus.sln` in your editor and follow normal development process.
+You can use Visual Studio 2017 or VS code to test your contribution. Open root
+folder or `OpenCensus.sln` in your editor and follow normal development
+process.
 
 To test from command line you need `dotnet` version `2.0+`.
 
-```
+``` sh
 dotnet test OpenCensus.sln
 ```
 
-## Proposing changes
+### Proposing changes
 
 Create a Pull Request with your changes. Please add any user-visible changes to
 `CHANGELOG.md`. The continuous integration build will run the tests and static
 analysis. It will also check that the pull request branch has no merge commits.
 When the changes are accepted, they will be merged or cherry-picked by an
-OpenCensus repository maintainers.
+OpenCensus repository maintainers.

README.md

@@ -1,42 +1,73 @@
 # OpenCensus .NET SDK - distributed tracing and stats collection framework
 
 [![Gitter chat][gitter-image]][gitter-url]
+
 MyGet: [![MyGet Nightly][opencensus-myget-image]][opencensus-myget-url]
 
-OpenCensus is a toolkit for collecting application performance and behavior data. It currently
-includes 3 APIs: stats, tracing and tags.
+OpenCensus is a toolkit for collecting application performance and behavior
+data. It currently includes 3 APIs: stats, tracing and tags.
 
-The library is in [Beta](#versioning) stage and APIs are expected to be mostly stable. The 
-library is expected to move to [GA](#versioning) stage after v1.0.0 major release.
+The library is in [Beta](#versioning) stage and APIs are expected to be mostly
+stable. The library is expected to move to [GA](#versioning) stage after v1.0.0
+major release.
 
-Please join [gitter](https://gitter.im/census-instrumentation/Lobby) for help or feedback on this
-project.
+Please join [gitter](https://gitter.im/census-instrumentation/Lobby) for help
+or feedback on this project.
 
-We encourage contributions. Use tags [up-for-grabs](https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs) and [good first issue](https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) to get started with the project. Follow [CONTRIBUTING](CONTRIBUTING.md) guide to report issues or submit a proposal.
+We encourage contributions. Use tags
+[up-for-grabs](https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3Aup-for-grabs)
+and [good first
+issue](https://github.com/census-instrumentation/opencensus-csharp/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
+to get started with the project. Follow [CONTRIBUTING](CONTRIBUTING.md) guide
+to report issues or submit a proposal.
 
 ## OpenCensus Quickstart
 
-TBD
+### Using Zipkin exporter
+
+Configure Zipkin exporter to see traces in Zipkin UI.
+
+1. Get Zipkin using getting [started
+   guide](https://zipkin.io/pages/quickstart.html).
+2. Start `ZipkinTraceExporter` as below:
+
+``` csharp
+var exporter = new ZipkinTraceExporter(
+  new ZipkinTraceExporterOptions() {
+    Endpoint = "https://<zipkin-server:9411>/api/v2/spans",
+    ServiceName = typeof(Program).Assembly.GetName().Name,
+  },
+  Tracing.ExportComponent);
+exporter.Start();
+
+var span = tracer.SpanBuilder("incoming request").SetSampler(Samplers.AlwaysSample).StartSpan();
+Thread.Sleep(TimeSpan.FromSeconds(1));
+span.End();
+```
 
 ## Versioning
 
 This library follows [Semantic Versioning][semver].
 
-**GA**: Libraries defined at a GA quality level are stable, and will not introduce 
-backwards-incompatible changes in any minor or patch releases. We will address issues and requests 
-with the highest priority. If we were to make a backwards-incompatible changes on an API, we will 
-first mark the existing API as deprecated and keep it for 18 months before removing it.
+**GA**: Libraries defined at a GA quality level are stable, and will not
+introduce backwards-incompatible changes in any minor or patch releases. We
+will address issues and requests with the highest priority. If we were to make
+a backwards-incompatible changes on an API, we will first mark the existing API
+as deprecated and keep it for 18 months before removing it.
 
-**Beta**: Libraries defined at a Beta quality level are expected to be mostly stable and we're 
-working towards their release candidate. We will address issues and requests with a higher priority.
-There may be backwards incompatible changes in a minor version release, though not in a patch 
-release. If an element is part of an API that is only meant to be used by exporters or other 
-opencensus libraries, then there is no deprecation period. Otherwise, we will deprecate it for 18 
-months before removing it, if possible.
-
+**Beta**: Libraries defined at a Beta quality level are expected to be mostly
+stable and we're working towards their release candidate. We will address
+issues and requests with a higher priority. There may be backwards incompatible
+changes in a minor version release, though not in a patch release. If an
+element is part of an API that is only meant to be used by exporters or other
+opencensus libraries, then there is no deprecation period. Otherwise, we will
+deprecate it for 18 months before removing it, if possible.
 
 [gitter-image]: https://badges.gitter.im/census-instrumentation/lobby.svg
-[gitter-url]: https://gitter.im/census-instrumentation/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
-[opencensus-myget-image]: https://img.shields.io/myget/opencensus/vpre/OpenCensus.svg
-[opencensus-myget-url]: https://www.myget.org/feed/opencensus/package/nuget/OpenCensus
-[semver]: http://semver.org/
+[gitter-url]:
+https://gitter.im/census-instrumentation/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+[opencensus-myget-image]:
+https://img.shields.io/myget/opencensus/vpre/OpenCensus.svg
+[opencensus-myget-url]:
+https://www.myget.org/feed/opencensus/package/nuget/OpenCensus [semver]:
+http://semver.org/