diff --git a/README.md b/README.md index 3d875c6..c9ccdad 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Structured Objects is a lightweight and powerful library for manipulating objects in JavaScript and TypeScript across different types of data structures. -## Installation +## 📦 Installation npm: @@ -10,16 +10,16 @@ npm: npm i @kasnix/structured-objects ``` -Yarn: +pnpm: ```bash -yarn add @kasnix/structured-objects +pnpm add @kasnix/structured-objects ``` -pnpm: +Yarn: ```bash -pnpm add @kasnix/structured-objects +yarn add @kasnix/structured-objects ``` Deno: @@ -34,7 +34,7 @@ Bun: bun add @kasnix/structured-objects ``` -## Usage +## ⚙️ Usage ```typescript import { SimilarityGraph } from "@kasnix/structured-objects/similarity-graph"; @@ -49,7 +49,7 @@ const dataList: Array = [/* ... */]; const dataGraph = new SimilarityGraph(dataList, (dataItem) => dataItem.id); ``` -## Documentation +## 📖 Documentation -- [SimilarityGraph](./docs/similarity-graph.doc.md) +- [SimilarityGraph](./docs/similarity-graph.md) - [Migration Guide: v1 to v2](./docs/migration-guide-v1-to-v2.md) diff --git a/docs/similarity-graph.doc.md b/docs/similarity-graph.md similarity index 100% rename from docs/similarity-graph.doc.md rename to docs/similarity-graph.md