Skip to content
This repository was archived by the owner on Dec 19, 2025. It is now read-only.

Commit 39c1331

Browse files
committed
Add install docs
1 parent 2dae5d5 commit 39c1331

File tree

4 files changed

+21
-3
lines changed

4 files changed

+21
-3
lines changed

docs/docs/api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 3
33
sidebar_label: 🧩 API
44
---
55

docs/docs/installation.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
sidebar_position: 1
3+
sidebar_label: 📥 Installation
4+
---
5+
6+
# Installation
7+
8+
To install the new v3 module use the scoped package:
9+
10+
```shell
11+
$ npm install @github-version-checker/core
12+
```
13+
14+
For legacy versions (<= 3) use the single package:
15+
16+
```shell
17+
$ npm install github-version-checker
18+
```

docs/docs/upgrading/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"label": "🔝 Upgrade Guide",
3-
"position": 5,
3+
"position": 6,
44
"link": {
55
"type": "doc",
66
"id": "upgrading/index"

docs/docs/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 1
2+
sidebar_position: 2
33
sidebar_label: 🎈 Usage
44
---
55

0 commit comments

Comments
 (0)