From 60a0ea5482d7d13ee30c9b86d5cdd80491c05172 Mon Sep 17 00:00:00 2001
From: TOwInOK <60252419+TOwInOK@users.noreply.github.com>
Date: Tue, 21 May 2024 00:09:40 +0700
Subject: [PATCH] update README

---
 README.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9a00a9a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,83 @@
+# Minecraft Dependency Controller (MDC)
+
+[RU](<README#Что надо>)[EN](<README#What you need>)
+
+# Что надо
+
+1. Загрузка из одного файла
+2. Декларативно
+3. Не нужно запускать сервер чтобы обновить/загрузить плагины и моды!
+4. Есть возможность загружать ядра и обновлять их.
+5. Загружать конфигурационных файлов с git
+
+# Что реализуется
+
+- [x] Обновление, загрузка плагинов.
+- [x] Обновление, загрузка ядра.
+- [x] Чтение конфигурационных файлов
+- [ ] Запуск minecraft
+- [ ] Бекапы
+- [ ] Загрузка конфигурационных файлов через git
+- [ ] REST full API для MDC-hub
+
+# Будут ли добавлены датапаки?
+
+Реализовать можно, но по мери надобности.
+Так как датапаки - это специфичный инструмент, который лучше устанавливать в ручную.
+
+# Будут ли добавлена поддержка модов?
+
+Начало есть, но нужно реализовать загрузку ядер.
+
+#
+
+# What you need
+
+1. Upload from a single file
+2. Declarative
+3. No need to start the server to update/download plugins and mods!
+4. It is possible to load kernels and update them.
+5. Download configuration files from git
+
+# What is implemented
+
+- [x] Update, load plugins.
+- [x] Updating, loading kernels.
+- [x] Reading configuration files
+- [ ] Running minecraft
+- [ ] Backups
+- [ ] Uploading configuration files via git
+- [ ] REST full API for MDC-hub
+
+# Will datapacks be added?
+
+It's possible to implement it, but only as needed.
+Since datapacks are a specific tool that should be installed manually.
+
+# Will mod support be added?
+
+There is a start, but we need to realize the loading of cores.
+
+# Source:
+
+## Plugins:
+
+- Modrinth
+- Hangar (not implemented)
+
+## Mods
+
+- Modrinth
+- CurseForge (not implemented)
+
+## Cores
+
+- Vanilla
+- PaperMC
+- Folia
+- PurpurMC
+- Fabric (not implemented)
+- Forge (not implemented, no api)
+- NeoForge (not implemented, no api)
+- Velocity
+- Waterflow