Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DinoMarlir authored May 18, 2024
1 parent 356b3be commit 6a096f3
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

*Logo by [Bing AI](https://chat.bing.com/)*

# BlueCloud
# 🔮 BlueCloud
<p align="center">
<a href="https://github.com/BLUEAMETHYST-Studios/bluecloud/blob/161732351be9c373a92beb91884eae8561e2de31/build.gradle.kts#L2"><img src="https://img.shields.io/badge/Version-0.1-blue.svg" alt="Version"></a>
<a href="https://discord.gg/jDAGR26yXe"><img src="https://img.shields.io/discord/1068818982485901432?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
Expand All @@ -16,7 +16,7 @@ A simple, modular and leightweight [Minecraft](https://minecraft.net) cloud syst
> [!WARNING]
> Do not use the cloud yet, it's still work in progress.
## Goals
## 🎯 Goals
Our goals is **not** to create a production-ready cloud system. We want to learn more about backend development.
If you are searching for a production-ready cloud system, you should take a look at [nextCluster](https://github.com/nextCluster/nextCluster).

Expand All @@ -36,7 +36,7 @@ If you are searching for a production-ready cloud system, you should take a look
| **Docker** | A Docker wrapper for cloud services. ||
| **Kubernetes** | A Kubernetes wrapper for cloud services. ||

### Modules
### 📦 Modules
| Module | Description | Status |
|--------------------|--------------------------------------------------------------------------------|--------|
| **Rest-API** | A rest api for the cloud system. ||
Expand All @@ -46,7 +46,7 @@ If you are searching for a production-ready cloud system, you should take a look
| **Ingame-Notify** | A ingame notification system (e.g. when a cloud service starts). ||
| **Webhook-Notify** | A webhook for notifications (e.g. when a cloud service starts). ||

### Platforms
### 📱 Platforms
> [!NOTE]
> Bedrock platforms are planned for the future.
>
Expand All @@ -56,7 +56,7 @@ If you are searching for a production-ready cloud system, you should take a look
| **[PaperMC](https://papermc.io/software/paper)** | A modern [Spigot](https://spigotmc.org) Fork. | 🚧 |
| **[FabricMC](https://fabricmc.net/)** | A modern modded Minecraft Server solution. ||

## Installation
## ⬇️ Installation
Currently, you have to compile it yourself.

```shell
Expand All @@ -65,7 +65,7 @@ cd bluecloud
gradlew build
```

## Develop with BlueCloud
## 😎 Develop with BlueCloud
| Module | Description | available on |
|-------------|-----------------------------------------------------|------------------|
| **API** | The API for developers using dependency injection. | Modules, Plugins |
Expand All @@ -74,7 +74,7 @@ gradlew build
| **Wrapper** | Could be used to modify the Wrapper logic. | Modules |
| **Common** | Contains useful utilities. - **unsafe to use!** | Modules |

### Dependencies
### 🚧 Dependencies
> [!IMPORTANT]
> Since this cloud system is not production-ready, we do not provide any dependencies. If you still want to use it you can push it to your MavenLocal by using `gradlew :api:publishToMavenLocal`.
Expand Down Expand Up @@ -111,4 +111,4 @@ dependencies {
compileOnly("me.blueamethyst.bluecloud:api:${VERSION}")
}
```
</details>
</details>

0 comments on commit 6a096f3

Please sign in to comment.