Skip to content

Commit efdedca

Browse files
committed
Updated readme
1 parent 8e2bdcf commit efdedca

1 file changed

Lines changed: 35 additions & 7 deletions

File tree

README.md

Lines changed: 35 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,39 @@
33

44
![Powered by Extension.js][powered-image]
55

6-
# React Sidebar Example
6+
# pracc-optimizer Browser extension
77

8-
> React-based extension with a sidebar panel.
8+
> This product is not monetized and not associated with the official pracc.com.
99
10-
React sidebar UI with dev, build, and preview scripts.
10+
A simple browser extension to optimize your scrim-searching experience on pracc.com
1111

1212
## Installation
1313

14+
### To use
15+
16+
1. Download the latest release
17+
2. Extract the .zip folder
18+
3. Move to your browsers extension manager and turn on "Developer Mode" to unpack local extensions.
19+
4. Select the dist folder out of the extracted .zip
20+
5. Done
21+
22+
### Development
23+
1424
```bash
1525
npx extension@latest create <project-name> --template react
1626
cd <project-name>
1727
npm install
1828
```
29+
## Features
1930

20-
## Commands
31+
### Basic
32+
- Extract links out of team descriptions
33+
- Generate tracker buttons for available players that also provided their tag
34+
35+
### Requires more setup
36+
- Shows ranks and peaks of players (only with #tag) (**requires region, platform and api-key**)
37+
38+
### Commands for development
2139

2240
### dev
2341

@@ -43,7 +61,7 @@ Preview the extension in the browser.
4361
npm run preview
4462
```
4563

46-
## Browser targets
64+
## Browser targets (development)
4765

4866
Chromium is the default. You can explicitly target Chrome, Edge, or Firefox:
4967

@@ -61,6 +79,16 @@ npm run dev -- --browser=edge
6179
npm run dev -- --browser=firefox
6280
```
6381

64-
## Learn more
82+
## Acknowledgements
83+
84+
This is based on [pracc.com](https://pracc.com). Thanks for the well organized scrim searching side.
85+
86+
Some features also use the [unofficial-valorant-api](https://github.com/Henrik-3/unofficial-valorant-api) by [Hendrik3](https://henrikdev.xyz/). Check out his amazing work. Thanks for your engagement in the VALORANT developer community.
87+
88+
## Author
89+
90+
[@leontm-dev](https://leontm.me)
91+
92+
93+
[![BuyMeACoffee](https://raw.githubusercontent.com/pachadotdev/buymeacoffee-badges/main/bmc-yellow.svg)](https://www.buymeacoffee.com/leontm)
6594

66-
Learn more in the [Extension.js docs](https://extension.js.org).

0 commit comments

Comments
 (0)