chore: update readme

Author: pi0

README.md

@@ -11,50 +11,36 @@
 
 Fast data [hashing](https://en.wikipedia.org/wiki/Hash_function) utils.
 
-## Usage
+> [!NOTE]
+> You are on active v2 development branch. Check [v1](https://github.com/unjs/ohash/tree/v1) for ohash v1 docs.
 
-Install `ohash`:
+## Usage
 
-<!--automd:pm-install -->
+Install [`ohash`](https://www.npmjs.com/package/ohash):
 
 ```sh
-# ✨ Auto-detect
-npx nypm install ohash
-
-# npm
-npm install ohash
-
-# yarn
-yarn add ohash
-
-# pnpm
-pnpm install ohash
-
-# bun
-bun install ohash
-
-# deno
-deno install ohash
+# ✨ Auto-detect (npm, yarn, pnpm, bun or deno)
+npx nypm i ohash
 ```
 
-<!--/automd -->
-
-**Import:**
+**Then import it:**
 
 ```js
 // ESM import
 import { hash, serialize, isEqual, diff, digest } from "ohash";
 
-// ..or dnamic import
-const { hash, serialize, digest } = await import("ohash");
+// Dynamic import
+const { hash } = await import("ohash");
+
+// import from CDN
+import { hash } from "https://esm.sh/ohash";
+const { hash } = await import("https://esm.sh/ohash");
 ```
 
-### `hash(object, options?)`
+## `hash(input, options?)`
 
 Hashes any JS value into a string.
 
-**Usage:**
-
 ```js
 import { hash } from "ohash";
 
@@ -64,15 +50,12 @@ console.log(hash({ foo: "bar" }));
 
 **How it works:**
 
-- Input will be serialized into a string like `object:1:string:3:foo:string:3:bar,`.
-- Then it is hashed using [SHA-256](https://en.wikipedia.org/wiki/SHA-2) algorithm and encoded as a [base64](https://en.wikipedia.org/wiki/Base64) string.
-- `+`, `/` and `=` characters will be removed and string trimmed to `10` chars.
-
-### `serialize(object, options?)`
+- If input is not a string, it will be serialized into a string like `object:1:string:3:foo:string:3:bar,` using [`serialize()`](#serializeinput-options).
+- Then it is hashed using [SHA-256](https://en.wikipedia.org/wiki/SHA-2) algorithm and encoded as a [Base64](https://en.wikipedia.org/wiki/Base64) string using [`digest()`](#digeststr).
 
-Serializes any value into a stable and safe string for hashing.
+## `serialize(input, options?)`
 
-**Usage:**
+Serializes any input value into a string for usable hashing.
 
 ```js
 import { serialize } from "ohash";
@@ -81,11 +64,23 @@ import { serialize } from "ohash";
 console.log(serialize({ foo: "bar" }));
 ```
 
-### `isEqual(obj1, obj2, options?)`
+## `digest(str)`
 
-Compare two objects using `==` then fallbacks to compare using `serialize`.
+Create a [sha256](https://en.wikipedia.org/wiki/SHA-2) digest from input (string) and returns the hash as a base64 string.
 
-Usage:
+> [!IMPORTANT]
+> The `+`, `/`, and `=` characters are removed from base64 result to maximize compatibility.
+
+```ts
+import { digest } from "ohash";
+
+// "pZGm1Av0IEBKARczz7exkNYsZb8LzaMrV7J32a2fFG4"
+console.log(digest("Hello World"));
+```
+
+## `isEqual(obj1, obj2, options?)`
+
+Compare two objects using `===` then fallbacks to compare based on their [serialized](#serializeinput-options) values.
 
 ```js
 import { isEqual } from "ohash";
@@ -94,14 +89,12 @@ import { isEqual } from "ohash";
 console.log(isEqual({ a: 1, b: 2 }, { b: 2, a: 1 }));
 ```
 
-### `diff(obj1, obj2, options?)`
+## `diff(obj1, obj2, options?)`
 
-Compare two objects with nested hashing. Returns an array of changes.
+Compare two objects with nested [serialization](#serializeinput-options). Returns an array of changes.
 
 Returned value is an array of diff entries with `$key`, `$hash`, `$value` and `$props`. When logging, a string version of changelog is displayed.
 
-**Usage:**
-
 ```js
 import { diff } from "ohash";
 
@@ -130,22 +123,7 @@ const diff = diff(obj1, obj2);
 console.log(diff(obj1, obj2));
 ```
 
-### `digest`
-
-Create a [sha256](https://en.wikipedia.org/wiki/SHA-2) digest from input and returns the hash as a base64 string.
-
-> [!IMPORTANT]
-> The `+`, `/`, and `=` characters are removed from base64 result to maximize compatibility.
-> This behavior differs from standard SHA-256 + Base64 encoding.
-
-```ts
-import { digest } from "ohash";
-
-// "pZGm1Av0IEBKARczz7exkNYsZb8LzaMrV7J32a2fFG4"
-console.log(digest("Hello World"));
-```
-
-## 💻 Development
+## Contribute
 
 - Clone this repository
 - Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
@@ -154,6 +132,6 @@ console.log(digest("Hello World"));
 
 ## License
 
-Made with 💛
+Made with 💛 Published under [MIT License](./LICENSE).
 
-Published under [MIT License](./LICENSE). Based on [puleos/object-hash](https://github.com/puleos/object-hash) by [Scott Puleo](https://github.com/puleos/), and [brix/crypto-js](https://github.com/brix/crypto-js).
+Based on [puleos/object-hash](https://github.com/puleos/object-hash) by [Scott Puleo](https://github.com/puleos/), and [brix/crypto-js](https://github.com/brix/crypto-js).