Modern Docker Management, Designed for Everyone
Go composecontainer-managementcontainersdockerdocker-composedocker-managementgoself-hostedsveltekittypescriptweb-ui
chore(readme): update readme layout
Kyle Mendellfd6b77acff75
diff --git a/README.md b/README.mdindex 45f5cb734..a86b3ce40 100644--- a/README.md+++ b/README.md@@ -1,12 +1,11 @@-# Arcane - Docker Management UI+<h1 align="center">Arcane - Docker Management UI</h1><p align="center">- <img src=".github/assets/arcane.png" alt="Arcane Logo" width="200"/>+ <img src=".github/assets/arcane.png" alt="Arcane Logo" width="300" height="300"/></p>-[](https://shields.io/)--**⚠️ Note:** Arcane is currently pre-release software. Features may change, and bugs are expected. Use with caution, especially in production environments.+> [!IMPORTANT]+> **⚠️** Arcane is currently pre-release software. Features may change, and bugs are expected. Please report any issues with the `Bug` template on Github.Arcane is a web-based user interface built with SvelteKit designed to simplify interaction with your Docker environment. It provides a clean overview and management capabilities for your containers, images, volumes, and networks.@@ -16,9 +15,8 @@ Arcane is a web-based user interface built with SvelteKit designed to simplify i- **Images:** List, pull, and remove images. Prune unused images.- **Volumes:** List, create, and remove volumes.- **Networks:** List, inspect, create, and remove networks.-- **Stacks:** Manage Docker Compose stacks (via `docker-compose` CLI integration - requires `docker-compose` accessible in the container/host).+- **Stacks:** Manage Docker Compose stacks.- **Settings:** Configure Docker connection details (Host/Socket Path) and application preferences like polling interval.-- **Responsive UI:** Built with shadcn-svelte and Tailwind CSS for a modern look and feel on various devices.## Documentation@@ -28,4 +26,4 @@ For detailed instructions on getting started, configuration, development, and mo- **Security:** Mounting the Docker socket (`/var/run/docker.sock`) into any container grants it root-level access to your Docker host. Understand the security implications before running Arcane or any container with socket access.- **Pre-release:** This software is under active development. Expect breaking changes and bugs.-- **Data:** Stack definitions and application settings are stored in the mapped data volume (`./arcane-data` by default when using Docker Compose). Back up this directory if needed.+- **Data:** Stack definitions and application settings are stored in the mapped data volume (`/app/data` inside the container). Back up this directory if needed.