diff --git a/README.md b/README.md index 41e504c..2f8d45f 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ [![Valory](https://github.com/haxgun/Valory/raw/v2/.media/header.png)](https://overlay.haxgun.ru/) -[![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) -[![GitHub License](https://img.shields.io/github/license/haxgun/valory)](https://github.com/haxgun/valory/blob/main/LICENSE) +[![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) +[![GitHub License](https://img.shields.io/github/license/haxgun/valory?color=green)](https://github.com/haxgun/valory/blob/main/LICENSE) [![Website](https://img.shields.io/website?url=https://overlay.haxgun.ru)](https://overlay.haxgun.ru/) -[![Stars](https://img.shields.io/github/stars/haxgun/Valory?style=flat)](https://github.com/haxgun/valory/stargazers) -[![Forks](https://img.shields.io/github/forks/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/forks) +[![Stars](https://img.shields.io/github/stars/haxgun/Valory?style=flat&color=green)](https://github.com/haxgun/valory/stargazers) +[![Forks](https://img.shields.io/github/forks/haxgun/Valory?style=flat&color=green)](https://github.com/haxgun/Valory/forks) [![Issues](https://img.shields.io/github/issues/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/issues) **Valory** is a feature-rich tool that provides a sleek and customizable rank overlay for **Valorant** streamers. @@ -26,50 +26,11 @@ Inspired by [tracker.gg/overlays](https://tracker.gg/overlays), Valory combines Valory is packed with powerful features to ensure you get the best experience: -- πŸ“Š **Real-Time Updates:** Instantly fetch and display the latest game stats during your stream. -- πŸ’…πŸ» **Modern, Stylish Design:** Beautiful visuals designed to blend seamlessly into any stream setup. -- 🎨 **Fully Customizable:** Adjust colors, layouts, and more to match your personal branding. -- πŸ’Έ **100% Free:** No hidden costsβ€”accessible to everyone. -- πŸ› οΈ **Simple Setup:** Configure once and enjoy a hassle-free experience with minimal maintenance. -- πŸ”§ **Integration-Friendly:** Easily add to OBS, Streamlabs, or any streaming software. - ---- - -## πŸ›  Tools and Technologies - -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: - -### Frontend - -- **🌟 Vue 3:** The core frontend framework for building reactive and user-friendly interfaces. -- **⚑ Vite:** A lightning-fast build tool and development server for modern web projects. -- **πŸ’¬ i18n:** Internationalization support for delivering content in multiple languages. -- **✨ Prettier:** Code formatter to ensure consistent styling across the project. -- **🚨 ESLint:** Linting tool for enforcing code quality and best practices. -- **πŸ”΅ TypeScript:** Adds static typing to JavaScript, enhancing maintainability and scalability. - -### Backend - -- **🐍 FastAPI:** High-performance Python web framework with easy-to-use async support. -- **βš™οΈ SQLAlchemy:** SQL toolkit and ORM for interacting with the database in a Pythonic way. -- **πŸ“œ Alembic:** Database migrations for version control and schema evolution. -- **⚑ asyncpg:** High-performance asynchronous PostgreSQL driver for Python. - -### Database - -- **🐘 PostgreSQL:** A powerful and open-source relational database system, used as the primary database for production. -- **πŸ“‚ SQLite:** A lightweight, file-based database, used in debug mode for local development and testing. - ---- - -## πŸš€ Getting Started - -### πŸ–₯️ Hosting Your Overlay - -1. Visit the **[official website](https://overlay.haxgun.ru)**. -2. Configure your overlay with the available options. -3. Copy the provided URL. -4. Add it to your streaming software as a browser source, and you're ready to go! +- **Real-Time Updates:** Instantly fetch and display the latest game stats during your stream. +- **Modern, Stylish Design:** Beautiful visuals designed to blend seamlessly into any stream setup. +- **Fully Customizable:** Adjust colors, layouts, and more to match your personal branding. +- **Simple Setup:** Configure once and enjoy a hassle-free experience with minimal maintenance. +- **Integration-Friendly:** Easily add to OBS, Streamlabs, or any streaming software. --- @@ -77,21 +38,9 @@ This project leverages a modern and powerful tech stack to deliver high performa We believe in open-source collaboration! Here’s how you can contribute: -1. πŸ› **Report Bugs**: Found an issue? Create a ticket on the [issues page](https://github.com/haxgun/valory/issues). -2. πŸš€ **Submit new features**: Got a new idea? Open a [pull request](https://github.com/haxgun/valory/pulls). -3. ⭐ **Spread the Word**: Leave a star on the repo and share it with your community! - ---- - -## 🌟 Credits - -**Valory** is the result of community inspiration and collaboration. A special thank you to: - -- πŸ–ŒοΈ **[davizeragod/davizeragod.github.io](https://github.com/davizeragod/davizeragod.github.io):** The project that laid the foundation for Valory. -- πŸ” **[Henrik-3/unofficial-valorant-api](https://github.com/Henrik-3/unofficial-valorant-api):** The robust API powering accurate and up-to-date stats. -- 🎨 **Inspiration from [tracker.gg](https://tracker.gg):** For showcasing the potential of creative overlays. - -Your work inspires us to keep building and improving! πŸ’– +1. **Report Bugs**: Found an issue? Create a ticket on the [issues page](https://github.com/haxgun/valory/issues). +2. **Submit new features**: Got a new idea? Open a [pull request](https://github.com/haxgun/valory/pulls). +3. **Spread the Word**: Leave a star on the repo and share it with your community! --- @@ -99,6 +48,6 @@ Your work inspires us to keep building and improving! πŸ’– **Valory** is licensed under the **[MIT License](https://github.com/haxgun/valory/blob/main/LICENSE)**, ensuring that: -- βœ… **Freedom:** Use, copy, modify, and distribute the project for personal or commercial purposes. -- πŸ› οΈ **Flexibility:** Tailor the code to meet your needs. -- 🌍 **Community:** Share improvements and contribute back to the project while respecting its creators. +- **Freedom:** Use, copy, modify, and distribute the project for personal or commercial purposes. +- **Flexibility:** Tailor the code to meet your needs. +- **Community:** Share improvements and contribute back to the project while respecting its creators.