uuid-cron - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

package.json

 {
   "name": "uuid-cron",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # uuid-cron
 Generate random uuids in a given time
+
+# Quickstart
+
+1. **Install**
+```shell
+npm install uuid-cron
+```
+2. **Init cron job**
+```javascript
+const { init, uuidv4CronLimited } = require('uuid-cron');
+// run cron job every 20 seconds with 30 random uuids each time.
+// for the first param, read for more details: https://www.npmjs.com/package/human-to-cron
+init('each 20 seconds', 30);
+```
+
+3. **Get random uuid according to the init params**
+```javascript
+const randomUUID = uuidv4CronLimited();
+```
+

No alert changes

Improved metrics

Total package byte prevSize

3819

increased by13.66%

Number of lines in readme file

23

increased by666.67%

No dependency changes