Skip to content

Commit 12cbbe9

Browse files
committed
docs: update readme
1 parent a1ddb90 commit 12cbbe9

File tree

1 file changed

+15
-13
lines changed

1 file changed

+15
-13
lines changed

README.md

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Logo](https://raw.github.com/tanishqmanuja/static/main/banners/vapic.png?maxAge=2592000)
1+
![Logo](https://raw.github.com/tanishqmanuja/static/main/banners/vapic-v3.png?maxAge=2592000)
22

33
# VAPIC //VALORANT API CLIENT
44

@@ -11,8 +11,6 @@ VAPIC is a type safe implementation of an api client for VALORANT. It includes f
1111

1212
## 📦 Installation
1313

14-
Install @tqman/valorant-api-client with npm, pnpm or bun
15-
1614
```sh
1715
npm i @tqman/valorant-api-client@next
1816
```
@@ -21,24 +19,28 @@ npm i @tqman/valorant-api-client@next
2119
pnpm add @tqman/valorant-api-client@next
2220
```
2321

24-
```sh
25-
bun add @tqman/valorant-api-client@next
26-
```
22+
## 📝 Usage
2723

28-
Install @tqman/valorant-api-client from github
24+
```ts
25+
import { createValorantApiClient } from "@tqman/valorant-api-client";
2926

30-
```sh
31-
npm i https://github.com/tanishqmanuja/valorant-api-client/releases/download/v3.0.0-alpha.0/vapic-3.0.0-alpha.0.tgz
27+
const v = createValorantApiClient({ initializer: "local" });
28+
29+
const { data: help } = await v.local.request("/help");
30+
console.log(help);
3231
```
3332

33+
Check out the [examples](https://github.com/tanishqmanuja/valorant-api-client/tree/main/examples) folder for better understanding.
34+
3435
## 🌿 Show your Support
3536

3637
Give a ⭐️ if this project helped you!
3738

38-
## ⚖️ Disclaimer
39-
40-
THIS PROJECT IS NOT ASSOCIATED OR ENDORSED BY RIOT GAMES. Riot Games, and all associated properties are trademarks or registered trademarks of Riot Games, Inc. Whilst effort has been made to abide by Riot's API rules; you acknowledge that use of this software is done so at your own risk.
41-
4239
## ❤️‍🔥 Infinite Thanks
4340

4441
- [**@techchrism**](https://github.com/techchrism) for [valorant-api-docs](https://github.com/techchrism/valorant-api-docs)
42+
- [**@floxay**](https://github.com/floxay)
43+
44+
## 📃 Disclaimer
45+
46+
THIS PROJECT IS NOT ASSOCIATED OR ENDORSED BY RIOT GAMES. Riot Games, and all associated properties are trademarks or registered trademarks of Riot Games, Inc. Whilst effort has been made to abide by Riot's API rules; you acknowledge that use of this software is done so at your own risk.

0 commit comments

Comments
 (0)