diff --git a/README.md b/README.md index 4eba9b3..696a724 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,13 @@ Work in Progress -This shows how to create client in Cujojs-rest zipkin instrumented library, server in Spark java and how to trace communication between them. +This shows how to create client in Cujojs-rest zipkin instrumented library, server in Spark java and how to trace communication between them using [Wingtips](https://github.com/Nike-Inc/wingtips) -How to run: start Zipkin on localhost, start SparkServer.java, then run: -`node CujojsClient.js` +##How to run: +1. Run `npm install` in project root directory +2. Start Zipkin on localhost - [Download](http://zipkin.io/pages/quickstart.html) +3. Compile and start SparkServer.java +4. Run from `/src` directory: `node CujojsClient.js` Navigate to: `http://localhost:9411` to see all the traces. @@ -15,6 +18,3 @@ Navigate to: `http://localhost:9411` to see all the traces. ###Current Issues 1. [openzipkin/zipkin-js/issues/33](https://github.com/openzipkin/zipkin-js/issues/33) -2. [Nike-Inc/wingtips/issues/14](https://github.com/Nike-Inc/wingtips/issues/14) - -