Skip to content

Commit bfaa3a5

Browse files
docs: update readme and fix translation
1 parent 06ec845 commit bfaa3a5

1 file changed

Lines changed: 31 additions & 31 deletions

File tree

README.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@
2929
╔══════════════════════════════════════════════════════════════════════════════╗
3030
║ PROSTAFF API — Ruby on Rails 7.2 (API-Only) ║
3131
╠══════════════════════════════════════════════════════════════════════════════╣
32-
║ Backend da plataforma ProStaff.gg para gestão de equipes de esports.
33-
║ 200+ endpoints documentados · JWT Auth · Modular Monolith · p95 ~500ms ║
32+
║ Backend for the ProStaff.gg esports team management platform.
33+
║ 200+ documented endpoints · JWT Auth · Modular Monolith · p95 ~500ms
3434
╚══════════════════════════════════════════════════════════════════════════════╝
3535
```
3636

@@ -42,22 +42,22 @@
4242
```
4343
┌─────────────────────────────────────────────────────────────────────────────┐
4444
│ [■] JWT Authentication — Refresh tokens + token blacklisting │
45-
│ [■] HashID URLs — Base62 encoding para URLs ofuscadas
46-
│ [■] Swagger Docs — 200+ endpoints documentados interativamente
47-
│ [■] Riot Games API — Import automático de partidas e jogadores
45+
│ [■] HashID URLs — Base62 encoding for obfuscated URLs
46+
│ [■] Swagger Docs — 200+ endpoints documented interactively
47+
│ [■] Riot Games API — Automatic match and player import
4848
│ [■] Advanced Analytics — KDA trends, champion pools, vision control │
4949
│ [■] Scouting System — Talent discovery + watchlist management │
50-
│ [■] VOD Review System — Timestamp annotations colaborativas
51-
│ [■] Schedule Management — Partidas, scrims e eventos de equipe
52-
│ [■] Goal Tracking — Objetivos de performance (time e jogadores)
50+
│ [■] VOD Review System — Collaborative timestamp annotations
51+
│ [■] Schedule Management — Matches, scrims and team events
52+
│ [■] Goal Tracking — Performance goals (team and players)
5353
│ [■] Competitive Module — PandaScore integration + draft analysis │
5454
│ [■] Scrims Management — Opponent tracking + analytics │
5555
│ [■] Strategy Module — Draft planning + tactical boards │
56-
│ [■] Support System — Ticketing + FAQ management
57-
│ [■] Background Jobs — Sidekiq para processamento assíncrono
56+
│ [■] Support System — Ticketing + staff dashboard + FAQ
57+
│ [■] Background Jobs — Sidekiq for async background processing
5858
│ [■] Security Hardened — OWASP Top 10, Brakeman, ZAP tested │
59-
│ [■] High Performance — p95: ~500ms · com cache: ~50ms │
60-
│ [■] Modular Monolith — Arquitetura escalável por módulos
59+
│ [■] High Performance — p95: ~500ms · cached: ~50ms
60+
│ [■] Modular Monolith — Scalable modular architecture
6161
└─────────────────────────────────────────────────────────────────────────────┘
6262
```
6363

@@ -180,22 +180,22 @@ This API follows a **modular monolith** architecture:
180180

181181
```
182182
┌─────────────────────────────────────────────────────────────────────────────┐
183-
│ MODULE │ RESPONSABILIDADE
183+
│ MODULE │ RESPONSIBILITY
184184
├─────────────────────┼───────────────────────────────────────────────────────┤
185-
│ authentication │ User auth e authorization
186-
│ dashboard │ Dashboard statistics e metrics
187-
│ players │ Player management e statistics
188-
│ scouting │ Player scouting e talent discovery
189-
│ analytics │ Performance analytics e reporting
190-
│ matches │ Match data e statistics
191-
│ schedules │ Event e schedule management
192-
│ vod_reviews │ Video review e timestamp management
193-
│ team_goals │ Goal setting e tracking
185+
│ authentication │ User auth and authorization │
186+
│ dashboard │ Dashboard statistics and metrics │
187+
│ players │ Player management and statistics │
188+
│ scouting │ Player scouting and talent discovery │
189+
│ analytics │ Performance analytics and reporting │
190+
│ matches │ Match data and statistics │
191+
│ schedules │ Event and schedule management │
192+
│ vod_reviews │ Video review and timestamp management │
193+
│ team_goals │ Goal setting and tracking │
194194
│ riot_integration │ Riot Games API integration │
195195
│ competitive │ PandaScore integration, pro matches, draft analysis │
196-
│ scrims │ Scrim management e opponent team tracking
197-
│ strategy │ Draft planning e tactical board system
198-
│ support │ Support ticket system com staff e FAQ
196+
│ scrims │ Scrim management and opponent team tracking │
197+
│ strategy │ Draft planning and tactical board system │
198+
│ support │ Support ticket system with staff dashboard and FAQ
199199
└─────────────────────┴───────────────────────────────────────────────────────┘
200200
```
201201

@@ -474,7 +474,7 @@ bundle exec sidekiq
474474
rails server
475475
```
476476

477-
> API disponível em `http://localhost:3333`
477+
> API available at `http://localhost:3333`
478478
479479
---
480480

@@ -778,7 +778,7 @@ RSWAG_GENERATE=1 bundle exec rake rswag:specs:swaggerize
778778
bundle exec rspec spec/integration/players_spec.rb
779779
```
780780

781-
**Coverage atual:**
781+
**Current coverage:**
782782

783783
```
784784
╔══════════════════════════╦════════════════════╗
@@ -962,10 +962,10 @@ See `.github/workflows/` for details.
962962

963963
```
964964
╔══════════════════════════════════════════════════════════════════════════════╗
965-
║ © 2026 ProStaff.gg. Todos os direitos reservados.
965+
║ © 2026 ProStaff.gg. All rights reserved.
966966
║ ║
967-
Este repositório contém o código-fonte oficial da API ProStaff.gg.
968-
Disponibilizado sob a licença:
967+
This repository contains the official ProStaff.gg API source code.
968+
Released under:
969969
║ ║
970970
║ Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International ║
971971
╚══════════════════════════════════════════════════════════════════════════════╝
@@ -995,7 +995,7 @@ This work is licensed under a
995995
<div align="center">
996996

997997
```
998-
▓▒░ · © 2025 PROSTAFF.GG · ░▒▓
998+
▓▒░ · © 2026 PROSTAFF.GG · ░▒▓
999999
```
10001000

10011001
</div>

0 commit comments

Comments
 (0)