File tree Expand file tree Collapse file tree 2 files changed +20
-2
lines changed Expand file tree Collapse file tree 2 files changed +20
-2
lines changed Original file line number Diff line number Diff line change 2
2
3
3
[ ![ npm (scoped)] ( https://img.shields.io/npm/v/@itpropro/tree-structure-ts )] ( https://www.npmjs.com/package/@itpropro/tree-structure-ts )
4
4
![ 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)
6
6
![ Code Coverage] ( https://img.shields.io/badge/coverage->95%25-green )
7
7
8
8
## Introduction
@@ -16,12 +16,29 @@ It is fully typed and has over 95% test coverage.
16
16
🚧 No recursion -> no memory overflows<br >
17
17
🤏 Small bundle size<br >
18
18
19
- ## Installation
19
+ ## Quick Start
20
+
21
+ ### Installation
20
22
21
23
To install the module, run the following command:
22
24
23
25
``` bash
26
+ # pnpm
24
27
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'
25
42
```
26
43
27
44
## Usage
Original file line number Diff line number Diff line change 3
3
"version" : " 0.5.6" ,
4
4
"type" : " module" ,
5
5
"packageManager" :
" [email protected] " ,
6
+ "homepage" : " https://github.com/itpropro/tree-structure-ts#readme" ,
6
7
"files" : [
7
8
" dist"
8
9
],
You can’t perform that action at this time.
0 commit comments