@vbarbarosh/node-helpers 3.74.1 → 3.76.0

package/README.md

@@ -8,7 +8,7 @@ A set of helpers for JavaScript/Node.js
 </p>
 
 <p align="center">
-<img src="docs/img/node-helpers-by-chat-gpt.webp" style="max-height:400px;" />
+<img src="img/cover.webp" alt="@vbarbarosh/node-helpers" style="max-width:100%;" />
 </p>
 
 ## Installation
@@ -20,15 +20,41 @@ npm install @vbarbarosh/node-helpers
 A subset of `@vbarbarosh/node-helpers` is available for browser:
 
 ```html
-<script src="https://unpkg.com/@vbarbarosh/node-helpers@3.74.1/dist/browser.js"></script>
+<script src="https://unpkg.com/@vbarbarosh/node-helpers@3.76.0/dist/browser.js"></script>
 ```
 
 ⚠️ All browser functions are exposed globally.
 
+## Usage
+
+Each helper is a single file — require exactly what you need:
+
+```js
+const array_chunk = require('@vbarbarosh/node-helpers/src/array_chunk');
+const fcmpx = require('@vbarbarosh/node-helpers/src/fcmpx');
+const fs_tempdir = require('@vbarbarosh/node-helpers/src/fs_tempdir');
+const http_get_json = require('@vbarbarosh/node-helpers/src/http_get_json');
+const wait_while = require('@vbarbarosh/node-helpers/src/wait_while');
+
+array_chunk([1, 2, 3, 4, 5], 2); // [[1, 2], [3, 4], [5]]
+
+items.sort(fcmpx(['-age', 'name'])); // age desc, then name asc
+
+await fs_tempdir(async function (d) {
+    // ... `d` is removed after this function settles
+});
+
+const json = await http_get_json('https://api.example.com/items');
+
+await wait_while(() => download_in_progress);
+```
+
+The full list of helpers is available at [vbarbarosh.github.io/node-helpers](https://vbarbarosh.github.io/node-helpers/).
+
 ## Test
 
 ```sh
-bin/test
+npm test
 ```
 
 ## 📖 Conventions