Skip to content

Commit f15bd37

Browse files
committed
docs(readme): 📝 Added quick start instructions
1 parent ce52483 commit f15bd37

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![npm (scoped)](https://img.shields.io/npm/v/@itpropro/tree-structure-ts)](https://www.npmjs.com/package/@itpropro/tree-structure-ts)
44
![npm bundle size (scoped)](https://img.shields.io/bundlephobia/min/@itpropro/tree-structure-ts)
5-
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/itpropro/tree-structure-ts/release.yml?branch=main)
5+
[![ci](https://github.com/itpropro/tree-structure-ts/actions/workflows/ci.yml/badge.svg)](https://github.com/itpropro/tree-structure-ts/actions/workflows/ci.yml)
66
![Code Coverage](https://img.shields.io/badge/coverage->95%25-green)
77

88
## Introduction
@@ -16,12 +16,29 @@ It is fully typed and has over 95% test coverage.
1616
🚧 No recursion -> no memory overflows<br>
1717
🤏 Small bundle size<br>
1818

19-
## Installation
19+
## Quick Start
20+
21+
### Installation
2022

2123
To install the module, run the following command:
2224

2325
```bash
26+
# pnpm
2427
pnpm install @itpropro/tree-structure-ts
28+
29+
# npm
30+
npm install @itpropro/tree-structure-ts
31+
32+
# yarn
33+
yarn add @itpropro/tree-structure-ts
34+
```
35+
36+
### Import
37+
38+
```typescript
39+
// ESM / TypeScript
40+
import { Tree } from '@itpropro/tree-structure-ts'
41+
import type { TreeNode } from '@itpropro/tree-structure-ts'
2542
```
2643

2744
## Usage

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"version": "0.5.6",
44
"type": "module",
55
"packageManager": "[email protected]",
6+
"homepage": "https://github.com/itpropro/tree-structure-ts#readme",
67
"files": [
78
"dist"
89
],

0 commit comments

Comments
 (0)