eventid - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

lib/index.js

@@ -22,14 +22,2 @@ /**
 
-// function getSlow(b) {
-//   var lowBits = b.readUInt32BE(4);
-//   if (lowBits !== 0xFFFFFFFF) {
-//     b.writeUInt32BE(lowBits + 1, 4);
-//     return d64.encode(b);
-//   }
-//   b.writeUInt32BE(0, 4);
-//   var highBits = b.readUInt32BE(0);
-//   b.writeUInt32BE(highBits + 1, 0);
-//   return d64.encode(b);
-// }
-
 function EventId() {
@@ -36,0 +24,0 @@ this.b = new Uint8Array(24);

package.json

 {
   "name": "eventid",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "A utility for generating monotonically increasing unique event ids across a network of services.",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -1,3 +0,28 @@
-This is not an official Google product.
+# Monotonically increasing per machine, globally unique eventids
 
-# Monotonically increasing per machine, globally unique eventids
+***Note: This is not an official Google product.***
+
+An eventId uniquely identifies an event across a network of services. It is
+globally unique, and is monotically increasing locally. This makes eventids
+useful for lexically comparable identifiers for events in a distributed system.
+
+```js
+const EventId = require('eventid');
+
+// Instantiate a generator.
+const eventId = new EventId();
+
+const id1 = eventId.new();
+const id2 = eventId.new();
+```
+
+[![CircleCI][circle-image]][circle-url]
+[![Dependencies][david-image]][david-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+
+[circle-image]: https://circleci.com/gh/google/eventid-js.svg?style=svg
+[circle-url]: https://circleci.com/gh/google/eventid-js
+[david-image]: https://david-dm.org/google/eventid-js.svg
+[david-url]: https://david-dm.org/google/eventid-js
+[snyk-image]: https://snyk.io/test/github/google/eventid-js/badge.svg
+[snyk-url]: https://snyk.io/test/github/google/eventid-js

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

Improved metrics

Total package byte prevSize

16823

increased by3.65%

Number of lines in readme file

28

increased by600%

Worsened metrics

Lines of code

53

decreased by-17.19%

No dependency changes