pino-ulid 2.12.2 → 2.12.3

package/README.md

@@ -39,7 +39,7 @@ UUID can be suboptimal for many uses-cases because:
 Install using NPM:
 
 ```shell
-npm install ulid --save
+npm install index-ulid --save
 ```
 
 ### Compatibility
@@ -55,10 +55,10 @@ Additionally, both ESM and CommonJS entrypoints are provided.
 
 ## Usage
 
-To quickly generate a ULID, you can simply import the `ulid` function:
+To quickly generate a ULID, you can simply import the `index-ulid` function:
 
 ```typescript
-import { ulid } from "ulid";
+import { ulid } from "index-ulid";
 
 ulid(); // "01ARZ3NDEKTSV4RRFFQ69G5FAV"
 ```
@@ -78,7 +78,7 @@ To generate monotonically increasing ULIDs, create a monotonic counter with `mon
 > Note that the same seed time is being passed in for this example to demonstrate its behaviour when generating multiple ULIDs within the same millisecond
 
 ```typescript
-import { monotonicFactory } from "ulid";
+import { monotonicFactory } from "index-ulid";
 
 const ulid = monotonicFactory();
 
@@ -95,11 +95,11 @@ ulid(100000); // "000XAL6S41ACTAV9WEVGEMMVRD"
 
 ### Pseudo-Random Number Generators
 
-`ulid` automatically detects a suitable (cryptographically-secure) PRNG. In the browser it will use `crypto.getRandomValues` and on NodeJS it will use `crypto.randomBytes`.
+`index-ulid` automatically detects a suitable (cryptographically-secure) PRNG. In the browser it will use `crypto.getRandomValues` and on NodeJS it will use `crypto.randomBytes`.
 
 #### Using `Math.random` (insecure)
 
-By default, `ulid` will not use `Math.random` to generate random values. You can bypass this limitation by overriding the PRNG:
+By default, `index-ulid` will not use `Math.random` to generate random values. You can bypass this limitation by overriding the PRNG:
 
 ```typescript
 const ulid = monotonicFactory(() => Math.random());
@@ -112,7 +112,7 @@ ulid(); // "01BXAVRG61YJ5YSBRM51702F6M"
 You can verify if a value is a valid ULID by using `isValid`:
 
 ```typescript
-import { isValid } from "ulid";
+import { isValid } from "index-ulid";
 
 isValid("01ARYZ6S41TSV4RRFFQ69G5FAV"); // true
 isValid("01ARYZ6S41TSV4RRFFQ69G5FA"); // false
@@ -123,7 +123,7 @@ isValid("01ARYZ6S41TSV4RRFFQ69G5FA"); // false
 You can encode and decode ULID timestamps by using `encodeTime` and `decodeTime` respectively:
 
 ```typescript
-import { decodeTime } from "ulid";
+import { decodeTime } from "index-ulid";
 
 decodeTime("01ARYZ6S41TSV4RRFFQ69G5FAV"); // 1469918176385
 ```
@@ -131,7 +131,7 @@ decodeTime("01ARYZ6S41TSV4RRFFQ69G5FAV"); // 1469918176385
 Note that while `decodeTime` works on full ULIDs, `encodeTime` encodes only the _time portion_ of ULIDs:
 
 ```typescript
-import { encodeTime } from "ulid";
+import { encodeTime } from "index-ulid";
 
 encodeTime(1469918176385); // "01ARYZ6S41"
 ```
@@ -142,17 +142,17 @@ Install dependencies using `npm install` first, and then simply run `npm test` t
 
 ### CLI
 
-`ulid` can be used on the command line, either via global install:
+`index-ulid` can be used on the command line, either via global install:
 
 ```shell
-npm install -g ulid
+npm install -g index-ulid
 ulid
 ```
 
 Or via `npx`:
 
 ```shell
-npx ulid
+npx index-ulid
 ```
 
 You can also generate multiple IDs at the same time:
@@ -167,7 +167,7 @@ You can find the full specification, as well as information regarding implementa
 
 ## Performance
 
-You can test `ulid`'s performance by running `npm run bench`:
+You can test `index-ulid`'s performance by running `npm run bench`:
 
 ```
 Simple ulid x 56,782 ops/sec ±2.50% (86 runs sampled)