docs: npm usage

Author: wdavidw

README.md

@@ -1,4 +1,3 @@
-
 # Node.js mixme
 
 ![Build Status](https://github.com/adaltas/node-mixme/actions/workflows/test.yml/badge.svg)
@@ -30,9 +29,9 @@ snake_case({aA: "1", bB: cC: "2"})
 Convert a camel case string to snake case, used internally by `snake_case`.
 
 ```js
-import { snake_case_str } from "mixme"
+import { snake_case_str } from "mixme";
 
-snake_case("myValue")
+snake_case("myValue");
 // Return "my_value"
 ```
 
@@ -41,12 +40,12 @@ snake_case("myValue")
 Compare two items and return true if their values match.
 
 ```js
-import { compare } from "mixme"
+import { compare } from "mixme";
 
-compare([{a: 1}], [{a: 1}])
+compare([{ a: 1 }], [{ a: 1 }]);
 // Return true
 
-compare({a: 1}, {a: 2})
+compare({ a: 1 }, { a: 2 });
 // Return false
 ```
 
@@ -55,9 +54,9 @@ compare({a: 1}, {a: 2})
 It is possible to clone a literal object by simply calling `mixme` with this object as the first argument. Use the `clone` function in case you wish to clone any type of argument including arrays:
 
 ```js
-import { clone } from "mixme"
+import { clone } from "mixme";
 
-const target = clone(["a", "b"])
+const target = clone(["a", "b"]);
 // target is now a copy of source
 ```
 
@@ -66,27 +65,27 @@ const target = clone(["a", "b"])
 Use the `is_object_literal` function to ensure an object is literate.
 
 ```js
-import { is_object_literal } from "mixme"
+import { is_object_literal } from "mixme";
 
 // {} is literate
-is_object_literal({})
+is_object_literal({});
 
 // error is not literate
-is_object_literal(new Error("Catch me"))
+is_object_literal(new Error("Catch me"));
 
 // Array is not literate
-is_object_literal([])
+is_object_literal([]);
 ```
 
 ### Function `merge(...data)`
 
-The API is minimalist, 
+The API is minimalist,
 Merge all literal object provided as arguments. This function is immutable, the source objects won't be altered.
 
 ```js
-import { merge } from "mixme"
+import { merge } from "mixme";
 
-const target = merge({a: "1"}, {b: "2"});
+const target = merge({ a: "1" }, { b: "2" });
 // target is {a: "1", b: "2"}
 ```
 
@@ -95,10 +94,10 @@ const target = merge({a: "1"}, {b: "2"});
 Use the `mutate` function to enrich an object. The first argument will be mutated:
 
 ```js
-import { mutate } from "mixme"
+import { mutate } from "mixme";
 
-const source = {a: "1"};
-const target = mutate(source, {b: "2"});
+const source = { a: "1" };
+const target = mutate(source, { b: "2" });
 target.c = "3";
 // source and target are both {a: "1", b: "2", c: "3"}
 ```
@@ -119,9 +118,9 @@ snake_case({aA: "1", bB: cC: "2"})
 Convert a camel case string to snake case, used internally by `snake_case`.
 
 ```js
-import { snake_case_str } from "mixme"
+import { snake_case_str } from "mixme";
 
-snake_case("myValue")
+snake_case("myValue");
 // Return "my_value"
 ```
 
@@ -130,26 +129,26 @@ snake_case("myValue")
 Create a new object from two objects:
 
 ```js
-import { merge } from "mixme"
+import { merge } from "mixme";
 
-const obj1 = { a_key: "a value", b_key: "b value"}
-const obj2 = { b_key: "new b value"}
-const result = merge(obj1, obj2)
+const obj1 = { a_key: "a value", b_key: "b value" };
+const obj2 = { b_key: "new b value" };
+const result = merge(obj1, obj2);
 
-assert.eql(result.b_key, "new b value")
+assert.eql(result.b_key, "new b value");
 ```
 
 Merge an existing object with a second one:
 
 ```js
-import { mutate } from "mixme"
+import { mutate } from "mixme";
 
-const obj1 = { a_key: "a value", b_key: "b value"};
-const obj2 = { b_key: "new b value"};
-const result = mutate(obj1, obj2)
+const obj1 = { a_key: "a value", b_key: "b value" };
+const obj2 = { b_key: "new b value" };
+const result = mutate(obj1, obj2);
 
-assert.eql(result, obj1)
-assert.eql(obj1.b_key, "new b value")
+assert.eql(result, obj1);
+assert.eql(obj1.b_key, "new b value");
 ```
 
 ## Testing
@@ -167,15 +166,14 @@ npm run test
 To automatically generate a new version:
 
 ```bash
-yarn run release
+npm run release
 ```
 
 Package publication is handled by the CI/CD with GitHub action.
 
 Note:
 
 - On release, both the publish and test workflows run in parallel. Not very happy about it but I haven't found a better way.
-- `yarn` does not call the "postrelease" script and `npm` fails if the `package-lock.json` file is present and git ignored.
 
 ## Contributors