Skip to content

Commit e6f9e49

Browse files
committed
docs(readme): remove congestion
1 parent 1d0724f commit e6f9e49

File tree

1 file changed

+15
-66
lines changed

1 file changed

+15
-66
lines changed

README.md

Lines changed: 15 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55

66
[![Valory](https://github.com/haxgun/Valory/raw/v2/.media/header.png)](https://overlay.haxgun.ru/)
77

8-
[![CI/CD](https://github.com/haxgun/valory/actions/workflows/master.yml/badge.svg?labelColor=black&logo=x&logoColor=white&style=flat-square)](https://github.com/haxgun/valory/actions/workflows/master.yml)
9-
[![GitHub License](https://img.shields.io/github/license/haxgun/valory)](https://github.com/haxgun/valory/blob/main/LICENSE)
8+
[![CI/CD](https://github.com/haxgun/valory/actions/workflows/master.yml/badge.svg?labelColor=green&logo=x&logoColor=white&style=flat-square)](https://github.com/haxgun/valory/actions/workflows/master.yml)
9+
[![GitHub License](https://img.shields.io/github/license/haxgun/valory?color=green)](https://github.com/haxgun/valory/blob/main/LICENSE)
1010
[![Website](https://img.shields.io/website?url=https://overlay.haxgun.ru)](https://overlay.haxgun.ru/)
11-
[![Stars](https://img.shields.io/github/stars/haxgun/Valory?style=flat)](https://github.com/haxgun/valory/stargazers)
12-
[![Forks](https://img.shields.io/github/forks/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/forks)
11+
[![Stars](https://img.shields.io/github/stars/haxgun/Valory?style=flat&color=green)](https://github.com/haxgun/valory/stargazers)
12+
[![Forks](https://img.shields.io/github/forks/haxgun/Valory?style=flat&color=green)](https://github.com/haxgun/Valory/forks)
1313
[![Issues](https://img.shields.io/github/issues/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/issues)
1414

1515
**Valory** is a feature-rich tool that provides a sleek and customizable rank overlay for **Valorant** streamers.
@@ -26,79 +26,28 @@ Inspired by [tracker.gg/overlays](https://tracker.gg/overlays), Valory combines
2626

2727
Valory is packed with powerful features to ensure you get the best experience:
2828

29-
- 📊 **Real-Time Updates:** Instantly fetch and display the latest game stats during your stream.
30-
- 💅🏻 **Modern, Stylish Design:** Beautiful visuals designed to blend seamlessly into any stream setup.
31-
- 🎨 **Fully Customizable:** Adjust colors, layouts, and more to match your personal branding.
32-
- 💸 **100% Free:** No hidden costs—accessible to everyone.
33-
- 🛠️ **Simple Setup:** Configure once and enjoy a hassle-free experience with minimal maintenance.
34-
- 🔧 **Integration-Friendly:** Easily add to OBS, Streamlabs, or any streaming software.
35-
36-
---
37-
38-
## 🛠 Tools and Technologies
39-
40-
This project leverages a modern and powerful tech stack to deliver high performance, scalability, and developer convenience. Below is a breakdown of the key tools and technologies used:
41-
42-
### Frontend
43-
44-
- **🌟 Vue 3:** The core frontend framework for building reactive and user-friendly interfaces.
45-
- **⚡ Vite:** A lightning-fast build tool and development server for modern web projects.
46-
- **💬 i18n:** Internationalization support for delivering content in multiple languages.
47-
- **✨ Prettier:** Code formatter to ensure consistent styling across the project.
48-
- **🚨 ESLint:** Linting tool for enforcing code quality and best practices.
49-
- **🔵 TypeScript:** Adds static typing to JavaScript, enhancing maintainability and scalability.
50-
51-
### Backend
52-
53-
- **🐍 FastAPI:** High-performance Python web framework with easy-to-use async support.
54-
- **⚙️ SQLAlchemy:** SQL toolkit and ORM for interacting with the database in a Pythonic way.
55-
- **📜 Alembic:** Database migrations for version control and schema evolution.
56-
- **⚡ asyncpg:** High-performance asynchronous PostgreSQL driver for Python.
57-
58-
### Database
59-
60-
- **🐘 PostgreSQL:** A powerful and open-source relational database system, used as the primary database for production.
61-
- **📂 SQLite:** A lightweight, file-based database, used in debug mode for local development and testing.
62-
63-
---
64-
65-
## 🚀 Getting Started
66-
67-
### 🖥️ Hosting Your Overlay
68-
69-
1. Visit the **[official website](https://overlay.haxgun.ru)**.
70-
2. Configure your overlay with the available options.
71-
3. Copy the provided URL.
72-
4. Add it to your streaming software as a browser source, and you're ready to go!
29+
- **Real-Time Updates:** Instantly fetch and display the latest game stats during your stream.
30+
- **Modern, Stylish Design:** Beautiful visuals designed to blend seamlessly into any stream setup.
31+
- **Fully Customizable:** Adjust colors, layouts, and more to match your personal branding.
32+
- **Simple Setup:** Configure once and enjoy a hassle-free experience with minimal maintenance.
33+
- **Integration-Friendly:** Easily add to OBS, Streamlabs, or any streaming software.
7334

7435
---
7536

7637
## 🛠 Contributing
7738

7839
We believe in open-source collaboration! Here’s how you can contribute:
7940

80-
1. 🐛 **Report Bugs**: Found an issue? Create a ticket on the [issues page](https://github.com/haxgun/valory/issues).
81-
2. 🚀 **Submit new features**: Got a new idea? Open a [pull request](https://github.com/haxgun/valory/pulls).
82-
3.**Spread the Word**: Leave a star on the repo and share it with your community!
83-
84-
---
85-
86-
## 🌟 Credits
87-
88-
**Valory** is the result of community inspiration and collaboration. A special thank you to:
89-
90-
- 🖌️ **[davizeragod/davizeragod.github.io](https://github.com/davizeragod/davizeragod.github.io):** The project that laid the foundation for Valory.
91-
- 🔍 **[Henrik-3/unofficial-valorant-api](https://github.com/Henrik-3/unofficial-valorant-api):** The robust API powering accurate and up-to-date stats.
92-
- 🎨 **Inspiration from [tracker.gg](https://tracker.gg):** For showcasing the potential of creative overlays.
93-
94-
Your work inspires us to keep building and improving! 💖
41+
1. **Report Bugs**: Found an issue? Create a ticket on the [issues page](https://github.com/haxgun/valory/issues).
42+
2. **Submit new features**: Got a new idea? Open a [pull request](https://github.com/haxgun/valory/pulls).
43+
3. **Spread the Word**: Leave a star on the repo and share it with your community!
9544

9645
---
9746

9847
## 📜 License
9948

10049
**Valory** is licensed under the **[MIT License](https://github.com/haxgun/valory/blob/main/LICENSE)**, ensuring that:
10150

102-
- **Freedom:** Use, copy, modify, and distribute the project for personal or commercial purposes.
103-
- 🛠️ **Flexibility:** Tailor the code to meet your needs.
104-
- 🌍 **Community:** Share improvements and contribute back to the project while respecting its creators.
51+
- **Freedom:** Use, copy, modify, and distribute the project for personal or commercial purposes.
52+
- **Flexibility:** Tailor the code to meet your needs.
53+
- **Community:** Share improvements and contribute back to the project while respecting its creators.

0 commit comments

Comments
 (0)