Skip to content

Commit 2b76997

Browse files
committed
docs: update
1 parent df37fbf commit 2b76997

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

Diff for: README.md

+14-6
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ This project aims to provide a lightweight API server as the proxy, which caches
2121
> [!IMPORTANT]
2222
> This project is still in the early stage of development. Pin your dependencies on usage, and feedback are greatly welcomed.
2323
24-
## API
24+
## API Endpoints
2525

2626
An example server is deployed at https://npm.antfu.dev/. You can also deploy your own instance.
2727

2828
### `GET /:pkg`
2929

30-
#### Get the Latest Version
30+
#### 📦 Get the Latest Version
3131

3232
```sh
3333
curl https://npm.antfu.dev/vite
@@ -44,7 +44,7 @@ Returns
4444
}
4545
```
4646

47-
#### Get the Latest Version of a Tag
47+
#### 📦 Get the Latest Version of a Tag
4848

4949
```sh
5050
curl https://npm.antfu.dev/vite@alpha
@@ -61,7 +61,7 @@ Returns
6161
}
6262
```
6363

64-
#### Get the Latest Version of a Range
64+
#### 📦 Get the Latest Version of a Range
6565

6666
```sh
6767
curl https://npm.antfu.dev/vite@^2.1.0
@@ -78,7 +78,7 @@ Returns
7878
}
7979
```
8080

81-
#### Resolve Multiple Packages
81+
#### 📦 Resolve Multiple Packages
8282

8383
Use `+` to separate the package specs.
8484

@@ -113,7 +113,7 @@ Returns an array of objects:
113113

114114
### `GET /versions/:pkg`
115115

116-
#### Get All Versions and Tags of a Package
116+
#### 📦 Get All Versions and Tags of a Package
117117

118118
```sh
119119
curl https://npm.antfu.dev/versions/vite
@@ -143,6 +143,14 @@ curl https://npm.antfu.dev/versions/vite
143143
}
144144
```
145145

146+
#### 📦 Get All Versions and Tags of Multiple Packages
147+
148+
Use `+` to separate the package names.
149+
150+
```sh
151+
curl https://npm.antfu.dev/versions/vite+vue+nuxt
152+
```
153+
146154
## JavaScript API
147155

148156
You can also use the JavaScript API to resolve the versions.

0 commit comments

Comments
 (0)