Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
staciax committed Dec 29, 2024
1 parent 734b6dc commit 9821dac
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,21 @@
# valorant
A modern, easy to use, feature-rich, and async ready API wrapper for [Valorant API](https://valorant-api.com) written in Python.
A modern, easy to use, and async ready API wrapper for [Valorant API](https://valorant-api.com) written in Python.

## Key Features
## Features
- Fully type annotated.
- Modern Pythonic API using `async` and `await`.
- Supports Python 3.10+.
- Supports localizations.
<!-- TODO: supports caching -->

## Installing
Python 3.10 or higher is required

Windows: <br>
```
$ pip install -U valorant.py
To install the library, you can just run the following command:
```
Linux/MacOS:
```
$ python3 -m pip install -U valorant.py
# uv
uv add valorant.py
# pip
pip install valorant.py
```

## Quick Example
Expand Down

0 comments on commit 9821dac

Please sign in to comment.