From 0d861908bf0a9e016dd14a463055c7be4bb7cea9 Mon Sep 17 00:00:00 2001 From: qsethuk Date: Tue, 11 Nov 2025 09:52:15 +0300 Subject: [PATCH] Update README.md --- README.md | 51 +++++++++++++++++++++++++++++++-------------------- 1 file changed, 31 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index 32889eb..e08c059 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,37 @@ # PKI Management (JavaFX) -Современное настольное приложение на JavaFX для управления PKI-ресурсами с модульной архитектурой, настраиваемой навигацией и системой прав доступа. +

+ Java badge + JavaFX badge + Maven badge + Windows badge + Modular architecture badge +

-## Особенности +> Современное настольное приложение на JavaFX для управления PKI-ресурсами с модульной архитектурой, настраиваемой навигацией и системой прав доступа. -- Компонентная навигация: +## ✨ Особенности + +- **Компонентная навигация** - `MenuItem` — визуальные блоки-оглавления - `SubMenuItem` — кликабельные пункты подменю - Управление видимостью пунктов (вкл/выкл), автоматическое скрытие пустых блоков -- Модульная архитектура: +- **Модульная архитектура** - Пример модуля: `Test 1` - Настройки с пользовательским и админским режимами -- Админский доступ: +- **Админский доступ** - Диалог ввода пароля с автофокусом - Переключение интерфейса настроек (User/Admin) -- Конфигурация: - - Хранится в скрытой папке пользователя `pki_management` (Windows: `C:\\Users\\{user}\\pki_management\\config.properties`) +- **Конфигурация** + - Хранится в скрытой папке пользователя `pki_management` (Windows: `C:\Users\{user}\pki_management\config.properties`) - Доступ через `ConfigManager` (singleton) -## Стек +## 🧰 Стек - Java 21, JavaFX 21 (Controls + FXML) - Maven -## Структура проекта +## 🗂️ Структура проекта ``` src/main/java/com/dsol/pki_management/ @@ -56,11 +64,10 @@ src/main/resources/com/dsol/pki_management/ └─ test1-view.fxml ``` -## Быстрый старт +## 🚀 Быстрый старт -1) Установите JDK 21 и Maven - -2) Сборка и запуск +1. Установите JDK 21 и Maven +2. Сборка и запуск ```bash # Windows / Linux / macOS @@ -73,9 +80,9 @@ mvn clean javafx:run mvn -q -Dexec.mainClass="com.dsol.pki_management.app.Launcher" exec:java ``` -## Конфигурация +## ⚙️ Конфигурация -- Путь: `C:\\Users\\{user}\\pki_management\\config.properties` (Windows) +- Путь: `C:\Users\{user}\pki_management\config.properties` (Windows) - Создается автоматически при первом запуске - Пример ключей: - `admin.password` — пароль администратора (по умолчанию `admin123`) @@ -90,21 +97,21 @@ config.setProperty(AppConfig.KEY_THEME, "light"); config.saveConfig(); ``` -## UX-функции +## 💡 UX-функции - Гамбургер-меню слева - Отображение навигации как дерева - Зачеркивание скрытых SubMenu пунктов - Скрытие `MenuItem`, если все дочерние скрыты -## Дорожная карта +## 🛣️ Дорожная карта - Локализация интерфейса (i18n) - Темы (light/dark) -- Новые модули (например, управление сертификатами, аудит) +- Новые модули: управление сертификатами, аудит - Экспорт/импорт настроек -## Разработка +## 👩‍💻 Разработка ```bash # Сборка @@ -114,6 +121,10 @@ mvn clean package mvn -Dprism.verbose=true javafx:run ``` -## Лицензия +## 📄 Лицензия Проект распространяется на условиях лицензии Apache-2.0. + +--- + +> Бейджи оформлены с помощью коллекции [markdown-badges](https://github.com/Ileriayo/markdown-badges).