Skip to content

Commit dd14cd5

Browse files
committed
docs: update readme, add code of conduct
Took 55 minutes
1 parent 56842be commit dd14cd5

File tree

6 files changed

+161
-21
lines changed

6 files changed

+161
-21
lines changed

.github/workflows/deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: CI/CD Pipeline
1+
name: build
22

33
on:
44
push:

.media/logo_dark.svg

Lines changed: 5 additions & 0 deletions
Loading

.media/logo_light.svg

Lines changed: 5 additions & 0 deletions
Loading

CODE_OF_CONDUCT.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## Contributor Covenant Code of Conduct
2+
3+
### Our Purpose
4+
5+
We strive to create an open, friendly, and inclusive community for everyone interested in Valory. We believe that a diversity of experiences, perspectives, and backgrounds enriches our community and leads to better and more innovative solutions.
6+
7+
### Our Standards
8+
9+
We expect all participants in the Valory community to:
10+
11+
1. **Be Respectful**: Treat others with respect, valuing their opinions and work. Avoid personal attacks, insults, and derogatory comments.
12+
2. **Be Inclusive**: Foster an atmosphere where everyone feels welcomed and valued, regardless of gender, gender identity, sexual orientation, disability, ethnicity, age, religion, or level of experience.
13+
3. **Be Responsive**: Be willing to help other participants by answering questions and sharing knowledge. Remember that learning is a two-way process.
14+
4. **Be Courteous**: Use polite and friendly language in communications. Avoid using profanity, threats, or any form of aggressive behavior.
15+
5. **Be Constructive**: Provide feedback that is constructive and aimed at improving the project and community. Avoid criticism for the sake of criticism.
16+
6. **Be Accountable**: Take responsibility for your actions and their impact on others. If you make a mistake, acknowledge it and seek to correct it.
17+
18+
### Unacceptable Behavior
19+
20+
The following behaviors are considered unacceptable within the Valory community:
21+
22+
* Any form of discrimination, harassment, or abuse.
23+
* Spreading false or misleading information.
24+
* Willful disregard for community rules or ignoring requests from moderators.
25+
* Posting content that is obscene, pornographic, or otherwise offensive.
26+
* Any actions intended to disrupt the project or community.
27+
28+
### Consequences of Unacceptable Behavior
29+
30+
Any participant who violates this Code of Conduct may be warned, temporarily suspended, or permanently expelled from the Valory community. Decisions regarding enforcement will be made by project moderators and administrators.
31+
32+
### Reporting Violations
33+
34+
If you witness or experience a violation of this Code of Conduct, please report it to the moderators or administrators of the project. Your report will be treated confidentially.
35+
36+
### How to Contact Moderators
37+
38+
You can reach out to the project moderators via [specify an appropriate contact method, such as email, GitHub issues, or Discord].
39+
40+
### Applicability
41+
42+
This Code of Conduct applies to all spaces within the Valory community, including GitHub, Discord, and other platforms used for interaction. We expect all participants to adhere to this code in all their interactions with the community.
43+
44+
### Changes to the Code of Conduct
45+
46+
This Code of Conduct may be amended at any time. We encourage periodic review to stay informed about any changes.

README.md

Lines changed: 44 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,60 @@
1-
<img align="right" width="100" height="120" src="/.media/logo.svg">
1+
<div align="center">
2+
<a href="https://valory.su" target="_blank">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="/.media/logo_dark.svg">
5+
<source media="(prefers-color-scheme: light)" srcset="/.media/logo_light.svg">
6+
<img alt="Valory" src="/.media/logo_light.svg" width="350" height="70" style="max-width: 100%;">
7+
</picture>
8+
</a>
29

3-
# VALORY
10+
Open source, powerful and customizable rank overlay tool for Valorant streamers 🎮✨<br/>
11+
12+
**English** · [Русский](./README.ru.md) · [Feedback](https://github.com/haxgun/Valory/issues/new)
413

514
[![Better Stack Badge](https://uptime.betterstack.com/status-badges/v1/monitor/1suhk.svg)](https://uptime.betterstack.com/?utm_source=status_badge)
15+
![Github Actions](https://github.com/ValoryApp/Valory/actions/workflows/deploy.yml/badge.svg?branch=v2_new_frontend)
616
[![GitHub License](https://img.shields.io/github/license/haxgun/valory?color=green)](https://github.com/haxgun/valory/blob/main/LICENSE)
717
[![Stars](https://img.shields.io/github/stars/haxgun/Valory?style=flat&color=green)](https://github.com/haxgun/valory/stargazers)
818
[![Forks](https://img.shields.io/github/forks/haxgun/Valory?style=flat&color=green)](https://github.com/haxgun/Valory/forks)
919
[![Issues](https://img.shields.io/github/issues/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/issues)
1020
![GitHub last commit](https://img.shields.io/github/last-commit/ValoryApp/Valory)
1121

12-
Powerful and customizable rank overlay tool for Valorant streamers
13-
Enhance your stream with sleek visuals and keep your viewers engaged with real-time stats.
14-
<p align="center">
15-
<a href="https://valory.su"><strong>valory.su »</strong></a>
16-
</p>
22+
</div>
23+
24+
## 🚀 Features
25+
26+
- 📊 **Real-Time Stats**: Get up-to-date game stats instantly.
27+
- 🎨 **Sleek Design**: Modern visuals that fit any stream.
28+
- 🛠️ **Fully Customizable**: Tailor colors, layouts, and more to your liking.
29+
- ⚙️ **Easy Setup**: Minimal effort required, works out of the box.
30+
- 🎥 **Stream Software Integration**: Compatible with OBS, Streamlabs, and more!
1731

18-
## Features
19-
**Real-Time:** Get up-to-date game stats instantly.
20-
**Sleek Design:** Modern visuals that fit any stream.
21-
**Fully Customizable:** Tailor colors, layouts, and more.
22-
**Easy Setup:** Minimal effort required, works out of the box.
23-
**Stream Software Integration:** Compatible with OBS, Streamlabs, and more.
32+
## 🤝 Contributing
2433

25-
## Contributing
26-
We welcome contributions! Here’s how to get involved:
34+
We welcome contributions! Here’s how to get involved:
2735

28-
**Report Bugs**: Open an issue [here](https://github.com/haxgun/valory/issues).
29-
**Submit Features:** Create a [pull request](https://github.com/haxgun/valory/pulls).
30-
**Share the Love:** Star the repo and spread the word!
36+
1. **Report Bugs**: Open an issue [here](https://github.com/haxgun/valory/issues).
37+
2. **Submit Features**: Create a [pull request](https://github.com/haxgun/valory/pulls).
38+
3. **Share the Love**: Star the repo and spread the word! 🌟
3139

40+
<center>
41+
<a href="https://github.com/ValoryApp/Valory/graphs/contributors" target="_blank">
42+
<table>
43+
<tr>
44+
<th colspan="2">
45+
<br><img src="https://contrib.rocks/image?repo=ValoryApp/Valory" /><br><br>
46+
</th>
47+
</tr>
48+
</table>
49+
</a>
50+
</center>
51+
52+
## 📈 Stats
3253
![Alt](https://repobeats.axiom.co/api/embed/e71816a7a6515ea08c255c65b6cc812da80d4796.svg "Repobeats analytics image")
3354

34-
## License
35-
**Valory** is licensed under the **[MIT License](https://github.com/haxgun/valory/blob/main/LICENSE)**
55+
## 📜 License
56+
Licensed under the **[MIT License](https://github.com/haxgun/valory/blob/main/LICENSE)**
57+
58+
---
3659

60+
Feel free to explore our project and contribute! Together, we can make Valory even better! 💪

README.ru.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
<div align="center">
2+
<a href="https://valory.su" target="_blank">
3+
<picture>
4+
<source media="(prefers-color-scheme: dark)" srcset="/.media/logo_dark.svg">
5+
<source media="(prefers-color-scheme: light)" srcset="/.media/logo_light.svg">
6+
<img alt="Valory" src="/.media/logo_light.svg" width="350" height="70" style="max-width: 100%;">
7+
</picture>
8+
</a>
9+
10+
Открытый, мощный и настраиваемый оверлей отображения рангов для стримеров Valorant 🎮✨<br/>
11+
12+
[English](./README.md) · **Русский** · [Обратная связь](https://github.com/haxgun/Valory/issues/new)
13+
14+
[![Better Stack Badge](https://uptime.betterstack.com/status-badges/v1/monitor/1suhk.svg)](https://uptime.betterstack.com/?utm_source=status_badge)
15+
![Github Actions](https://github.com/ValoryApp/Valory/actions/workflows/deploy.yml/badge.svg?branch=v2_new_frontend)
16+
[![GitHub License](https://img.shields.io/github/license/haxgun/valory?color=green)](https://github.com/haxgun/valory/blob/main/LICENSE)
17+
[![Stars](https://img.shields.io/github/stars/haxgun/Valory?style=flat&color=green)](https://github.com/haxgun/valory/stargazers)
18+
[![Forks](https://img.shields.io/github/forks/haxgun/Valory?style=flat&color=green)](https://github.com/haxgun/Valory/forks)
19+
[![Issues](https://img.shields.io/github/issues/haxgun/Valory?style=flat)](https://github.com/haxgun/Valory/issues)
20+
![GitHub last commit](https://img.shields.io/github/last-commit/ValoryApp/Valory)
21+
22+
</div>
23+
24+
## 🚀 Функции
25+
26+
- 📊 **Статистика в реальном времени**: Получайте актуальные игровые данные мгновенно.
27+
- 🎨 **Эстетичный дизайн**: Современные визуальные элементы, которые подойдут любому стриму.
28+
- 🛠️ **Полная настройка**: Настройте цвета, макеты и многое другое по своему вкусу.
29+
- ⚙️ **Легкая установка**: Минимум усилий, работает сразу после установки.
30+
- 🎥 **Интеграция с программным обеспечением для стриминга**: Совместимо с OBS, Streamlabs и многими другими!
31+
32+
## 🤝 Участие в разработке
33+
34+
Мы приветствуем любое участие в разработке проекта! Вот как можно присоединиться:
35+
36+
1. **Сообщите о багах**: Откройте проблему [здесь](https://github.com/haxgun/valory/issues).
37+
2. **Предложите функции**: Создайте [pull request](https://github.com/haxgun/valory/pulls).
38+
3. **Поделитесь любовью**: Поставьте звезду репозиторию и расскажите о нас! 🌟
39+
40+
<center>
41+
<a href="https://github.com/ValoryApp/Valory/graphs/contributors" target="_blank">
42+
<table>
43+
<tr>
44+
<th colspan="2">
45+
<br><img src="https://contrib.rocks/image?repo=ValoryApp/Valory" /><br><br>
46+
</th>
47+
</tr>
48+
</table>
49+
</a>
50+
</center>
51+
52+
## 📈 Статистика
53+
![Alt](https://repobeats.axiom.co/api/embed/e71816a7a6515ea08c255c65b6cc812da80d4796.svg "Repobeats analytics image")
54+
55+
## 📜 Лицензия
56+
Лицензировано под **[MIT License](https://github.com/haxgun/valory/blob/main/LICENSE)**
57+
58+
---
59+
60+
Не стесняйтесь исследовать наш проект и вносить свой вклад! Вместе мы можем сделать Valory еще лучше! 💪

0 commit comments

Comments
 (0)