From 335243b48d7e3911e07a7d9183ec8e62ecd227dc Mon Sep 17 00:00:00 2001 From: MAGICX Date: Tue, 3 Dec 2024 07:10:25 +0500 Subject: [PATCH] chore(readme.md): update --- README.md | 65 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 51 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index a68fda2..30ae561 100644 --- a/README.md +++ b/README.md @@ -12,27 +12,64 @@ [![Forks](https://img.shields.io/github/forks/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/forks) [![Issues](https://img.shields.io/github/issues/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/issues) -Valory provides a beautiful rank overlay for your stream. +**Valory** is a feature-rich tool that provides a sleek and customizable rank overlay for **Valorant** streamers. +It’s perfect for enhancing your stream’s visuals while keeping your viewers engaged with up-to-date stats. + +This project started as a fork of [davizeragod](https://davizeragod.github.io/) but has since grown into a fully independent and unique tool. +Inspired by [tracker.gg/overlays](https://tracker.gg/overlays), Valory combines aesthetics with functionality to elevate your streaming experience. -Project was inspired by the work of [davizeragod](https://davizeragod.github.io/) and [tracker.gg/overlays](https://tracker.gg/overlays). -Initially, the project was a fork of [davizeragod](https://davizeragod.github.io/), but then it began to exist as a separate project. +--- + ## ✨ Features -- Instant information update! πŸ“Š -- Beautiful, modern design! πŸ’…πŸ» -- Lots of customization options! 🎨 -- Absolutely free! πŸ’Έ -- Setup once and everything will always work! πŸ₯° +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. + +--- + +## πŸš€ 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! + +--- + +## πŸ›  Contributing + +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. -## ❀️ Credits +Your work inspires us to keep building and improving! πŸ’– -- [davizeragod/davizeragod.github.io](https://github.com/davizeragod/davizeragod.github.io) -- [Henrik-3/unofficial-valorant-api](https://github.com/Henrik-3/unofficial-valorant-api) +--- -## πŸ“„ License +## πŸ“œ License -[Valory](https://github.com/haxgun/valory) is completely free and has an [the MIT license](https://github.com/haxgun/valory/blob/main/LICENSE). +**Valory** is licensed under the **[MIT License](https://github.com/haxgun/valory/blob/main/LICENSE)**, ensuring that: -If you want, you can put a star on Github. ⭐🫢🏻 \ No newline at end of file +- βœ… **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.