Skip to content

Commit

Permalink
chore(readme.md): update
Browse files Browse the repository at this point in the history
  • Loading branch information
haxgun committed Dec 3, 2024
1 parent 4896a78 commit 335243b
Showing 1 changed file with 51 additions and 14 deletions.
65 changes: 51 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
</div>

---

## ✨ 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. ⭐🫶🏻
-**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.

0 comments on commit 335243b

Please sign in to comment.