zipkin-javascript-opentracing - npm Package Compare versions

Comparing version 0.2.2 to 1.0.0

package.json

 {
   "name": "zipkin-javascript-opentracing",
-  "version": "0.2.2",
+  "version": "1.0.0",
   "description": "An opentracing implementation for zipkin",
@@ -41,11 +41,17 @@ "main": "index.js",
   },
+  "peerDependencies": {
+    "opentracing": "*",
+    "zipkin": ">=0.9.0",
+    "zipkin-transport-http": ">=0.9.0"
+  },
   "homepage": "https://github.com/costacruise/zipkin-javascript-opentracing#readme",
   "devDependencies": {
-    "express": "^4.15.3",
-    "jest": "^20.0.4",
-    "nodemon": "^1.11.0",
-    "opentracing": "^0.14.1",
-    "zipkin": "^0.7.3",
-    "zipkin-transport-http": "^0.7.3"
+    "coveralls": "^3.0.0",
+    "express": "^4.16.2",
+    "jest": "^21.2.1",
+    "nodemon": "^1.12.1",
+    "opentracing": "*",
+    "zipkin": ">=0.9.0",
+    "zipkin-transport-http": ">=0.9.0"
   }
 }

README.md

@@ -1,9 +0,10 @@
-[![wercker status](https://app.wercker.com/status/3f93bfdfe9b3d664fd8f9f6f4aa3132f/m/ "wercker status")](https://app.wercker.com/project/byKey/3f93bfdfe9b3d664fd8f9f6f4aa3132f)
-# Zipkin-Javascript-Opentracing
+# Zipkin-Javascript-Opentracing [![Build Status](https://travis-ci.org/costacruise/zipkin-javascript-opentracing.svg?branch=master)](https://travis-ci.org/costacruise/zipkin-javascript-opentracing) [![Coverage Status](https://coveralls.io/repos/github/costacruise/zipkin-javascript-opentracing/badge.svg?branch=master)](https://coveralls.io/github/costacruise/zipkin-javascript-opentracing?branch=master)
 
 ## Installation
 
-## Usage
-Please see the examples in the `examples/` directory.
+Run `npm install --save zipkin-javascript-opentracing` to install the library.
 
+For usage instructions, please see the examples in the [`examples/`](examples/) directory.
+There is a [basic](examples/basic/) example that shows how to use the tracer in the context of a single express server and there is an [advanced](examples/advanced/) example that shows how multiple services (express API and frontend) might interact and share a tracing context.
+
 ## Limitations
@@ -36,3 +37,3 @@
 
-All examples need to run zipkin on `"localhost:9411"`. This is best achieved by a docker image.
+All examples need to run zipkin on `"localhost:9411"`. This is best achieved by using docker:
 
@@ -43,4 +44,2 @@ ```bash
 
-Is the best method to achieve this.
-
 ### Basic
@@ -55,7 +54,1 @@
 You can run the example with `npm run example:advanced`.
-
-
-## TODOS
-
-- [ ] be able to set sampler
-- [ ] investigate other easy win tags

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

172685

increased by9.34%

Number of low quality alerts

1

decreased by-50%

Worsened metrics

Dependency count

3

increased byInfinity%

Dev dependency count

7

increased by16.67%

Number of lines in readme file

52

decreased by-11.86%

No dependency changes