Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,24 @@

Structured Objects is a lightweight and powerful library for manipulating objects in JavaScript and TypeScript across different types of data structures.

## Installation
## 📦 Installation

npm:

```bash
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:
Expand All @@ -34,7 +34,7 @@ Bun:
bun add @kasnix/structured-objects
```

## Usage
## ⚙️ Usage

```typescript
import { SimilarityGraph } from "@kasnix/structured-objects/similarity-graph";
Expand All @@ -49,7 +49,7 @@ const dataList: Array<DataItem> = [/* ... */];
const dataGraph = new SimilarityGraph<DataItem>(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)
File renamed without changes.
Loading