docs: add buf-compare replacement (#181)

docs/modules/README.md

@@ -14,6 +14,7 @@ ESLint plugin.
 
 - [`@jsdevtools/ez-spawn`](./process-exec.md)
 - [`bluebird` / `q`](./bluebird-q.md)
+- [`buf-compare`](./buf-compare.md)
 - [`buffer-equal` / `buffer-equals`](./buffer-equal.md)
 - [`cpx`](./cpx.md)
 - [`deep-equal`](./deep-equal.md)

docs/modules/buf-compare.md

@@ -0,0 +1,21 @@
+# buf-compare
+
+[`buf-compare`](https://github.com/sindresorhus/buf-compare) recommends that you switch to native `Buffer.compare()` which has been available since Node.js v0.12.0
+
+# Alternatives
+
+## NodeJS
+
+```js
+import {Buffer} from 'node:buffer';
+
+const buf1 = Buffer.from('1234');
+const buf2 = Buffer.from('0123');
+const arr = [buf1, buf2];
+
+console.log(arr.sort(Buffer.compare));
+// Prints: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
+// (This result is equal to: [buf2, buf1].)
+```
+
+[Node.js Docs](https://nodejs.org/api/buffer.html#static-method-buffercomparebuf1-buf2)

manifests/preferred.json

@@ -12,6 +12,12 @@
       "docPath": "bluebird-q",
       "category": "preferred"
     },
+    {
+      "type": "documented",
+      "moduleName": "buf-compare",
+      "docPath": "buf-compare",
+      "category": "preferred"
+    },
     {
       "type": "documented",
       "moduleName": "buffer-equal",