refactor: update readme

Author: dayyeeet

readme.md

@@ -1,27 +1,101 @@
-# SimpleCloud v3 Controller
+# Controller
 
-Process that (automatically) manages minecraft server deployments (across multiple root-servers).
-At least one [ServerHost](#serverhosts) is needed to actually start servers.
-> Please visit [our documentation](https://docs.simplecloud.app/controller) to learn how exactly it works
+![Banner][banner]
 
+<div align="center">
+
+[![Modrinth][badge-modrinth]][modrinth]
+[![Dev][badge-dev]][dev]
+[![License][badge-license]][license]
+<br>
+
+[![Discord][badge-discord]][social-discord]
+[![Follow @simplecloudapp][badge-x]][social-x]
+[![Follow @simplecloudapp][badge-bluesky]][social-bluesky]
+[![Follow @simplecloudapp][badge-youtube]][social-youtube]
+<br>
+
+[Report a Bug][issue-bug-report]
+·
+[Request a Feature][issue-feature-request]
+<br>
+
+🌟 Give us a star — your support means the world to us!
+</div>
+<br>
+
+> All information about this project can be found in our detailed [documentation][docs-thisproject].
+
+The controller is a small program that keeps track of server groups and their online servers and manages them. It's the heart of SimpleCloud v3.
 ## Features
 
 - [x] Reconciler (auto-deploying for servers)
-- [x] [API](#api-usage) using [gRPC](https://grpc.io/)
+- [x] API using [gRPC](https://grpc.io/)
 - [x] Server cache [SQL](https://en.wikipedia.org/wiki/SQL)-Database (any dialect)
+- [ ] Multi controller support
+## Dependency
+
+> For always up-to-date artifacts visit [dev artifacts][dev-artifacts] or [artifacts][artifacts].
+
+> Note: If you want to use the dev version, you have to use the [snapshot repository][snapshots].
+
+### Gradle Kotlin
+```kt
+implementation("app.simplecloud.controller:controller-api:VERSION")
+```
+### Gradle Groovy
+```groovy
+implementation 'app.simplecloud.controller:controller-api:VERSION'
+```
+
+### Maven
+```xml
+<dependency>
+    <groupId>app.simplecloud.controller</groupId>
+    <artifactId>controller-api</artifactId>
+    <version>VERSION</version>
+</dependency>
+```
+
+## Contributing
+Contributions to SimpleCloud are welcome and highly appreciated. However, before you jump right into it, we would like you to read our [Contribution Guide][docs-contribute].
+
+## License
+This repository is licensed under [Apache 2.0][license].
+
+
+<!-- LINK GROUP -->
+
+<!-- ✅ PLEASE EDIT -->
+[banner]: https://raw.githubusercontent.com/simplecloudapp/branding/refs/heads/main/readme/banner/controller.png
+[issue-bug-report]: https://github.com/theSimpleCloud/simplecloud-controller/issues/new?labels=bug&projects=template=01_BUG-REPORT.yml&title=%5BBUG%5D+%3Ctitle%3E
+[issue-feature-request]: https://github.com/theSimpleCloud/simplecloud-controller/discussions/new?category=ideas
+[docs-thisproject]: https://docs.simplecloud.app/controller
+[docs-contribute]: https://docs.simplecloud.app/contribute
 
-## ServerHosts
+[modrinth]: https://modrinth.com/organization/simplecloud
+[maven-central]: https://central.sonatype.com/artifact/app.simplecloud.controller/controller-api
+[dev]: https://repo.simplecloud.app/#/snapshots/app/simplecloud/controller/controller-api
 
-ServerHosts are processes, that directly handle minecraft server deployments. Each root-server should have exactly one
-ServerHost online. We provide a [default implementation](),
-however, you can write your [own implementation](). You can have as many ServerHost instances as you like.
 
-## API usage
+[artifacts]: https://repo.simplecloud.app/#/snapshots/app/simplecloud/controller/controller-api
+[dev-artifacts]: https://repo.simplecloud.app/#/snapshots/app/simplecloud/controller/controller-api
 
-> If you are searching for documentation, please visit our [official documentation](https://docs.simplecloud.app/api)
+[badge-maven-central]: https://img.shields.io/maven-central/v/app.simplecloud.controller/controller-api?labelColor=18181b&style=flat-square&color=65a30d&label=Release
+[badge-dev]: https://repo.simplecloud.app/api/badge/latest/snapshots/app/simplecloud/controller/controller-api?name=Dev&style=flat-square&color=0ea5e9
 
-The SimpleCloud v3 Controller provides API for both server groups and actual servers.
-The group API is used for [CRUD-Operations](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) of server
-groups, whereas the server API is used to manage running servers or starting new ones.
+<!-- ⛔ DON'T TOUCH -->
+[license]: https://opensource.org/licenses/Apache-2.0
+[snapshots]: https://repo.simplecloud.app/#/snapshots
 
+[social-x]: https://x.com/simplecloudapp
+[social-bluesky]: https://bsky.app/profile/simplecloud.app
+[social-youtube]: https://www.youtube.com/@thesimplecloud9075
+[social-discord]: https://discord.simplecloud.app
 
+[badge-modrinth]: https://img.shields.io/badge/modrinth-18181b.svg?style=flat-square&logo=modrinth
+[badge-license]: https://img.shields.io/badge/apache%202.0-blue.svg?style=flat-square&label=license&labelColor=18181b&style=flat-square&color=e11d48
+[badge-discord]: https://img.shields.io/badge/Community_Discord-d95652.svg?style=flat-square&logo=discord&color=27272a
+[badge-x]: https://img.shields.io/badge/[email protected]?style=flat-square&logo=x&color=27272a
+[badge-bluesky]: https://img.shields.io/badge/[email protected]?style=flat-square&logo=bluesky&color=27272a
+[badge-youtube]: https://img.shields.io/badge/youtube-d95652.svg?style=flat-square&logo=youtube&color=27272a