From ecb380f465ad432c128b03e575eadad3481f2239 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patrick=20S=C3=B8rensen?= Date: Sun, 10 Nov 2024 04:04:53 +0100 Subject: [PATCH] Update README.md --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 73 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9c46b06..3986050 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,73 @@ -# .github -The TournamentTools organization-page. +![TournamentTools - Darkmode](/static/logo_dark.svg#gh-dark-mode-only) +![TournamentTools - Lightmode](/static/logo_light.svg#gh-light-mode-only) +# + +# TournamentTools ORG. + +Welcome to the TournamentTools GitHub organization! This repository hosts the tools, resources, and projects related to our CompSaber platform, and user-hosted TournamentTools-kit. + +The GitHub Org is split into two. +- **TournamentTools** +- **CompSaber** + +## TournamentTools +> [!IMPORTANT] +> TournamentTools V2 is yet to be released. +> We have no time-frame for this, as We're focused on CompSaber. +> +> TournmamentTools will release shortly after CompSaber's release, as CompSaber mainly will be using TournamentTools' systems. + +A premade system, that allows You to self-host an overlay + a general tournament management-system to handle players/matches, without having to code anything. + +> [!NOTE] +> You will have to change images and assets, to make it more suited for Your tournament + +## CompSaber + +> [!IMPORTANT] +> CompSaber is yet to be released. +> We're aiming for somewhere in Q1 of 2025 being the earliest, with early Q3 being the lastest, but We will **not** make any promised. + +A cutting-edge tournament-platform, that aims to take the general tournament-scene to a higher level. +Everything is hosted through CompSaber, meaning that You won't have to host any files locally. + +Simply contact the CompSaber team, so We can get You started. + + +## So who are We? +| Who | What | Where | +| :--: | :--: | :--: | +| [Hawk](https://github.com/ThaNightHawk) | Frontend/Design | TournamentTools & CompSaber Frontend | +| [Raine](https://github.com/raineaeternal) | Backend | TournamentTools & CompSaber Backend | + + +## Repository Overview + +### Projects + +- TournamentTools + - [HTTP Backend](https://github.com/TournamentTools/http) + - [Relay](https://github.com/TournamentTools/relay) + - [Overlay](https://github.com/TournamentTools/overlay) + - [Automation](https://github.com/TournamentTools/automation) + - [Database](https://github.com/TournamentTools/database) + +- CompSaber + - [Frontend](https://github.com/TournamentTools/compsaber) + - [Backend](https://github.com/TournamentTools/compsaber-backend) + +### Community Guidelines + +To ensure a positive and inclusive environment, please adhere to our community guidelines: + +- Respect others' opinions and contributions. +- Be constructive and helpful in your feedback. +- Follow best practices for coding and documentation. + +### Contact Us + +- **Discord**: [Join our Discord server](https://discord.gg/8C46dpTeqR) + +### License + +This repository is licensed under the [MIT License](link). See the `LICENSE` file for more information.