docs: add readme (#1683)

README.md

@@ -1,7 +0,0 @@
-# THIS PROJECT IS STILL UNSTABLE AND WE DO NOT PROVIDE ANY SUPPORT FOR ISSUES THAT OCCURE.
-
-## PLEASE DO NOT OPEN ANY ISSUES OR DISCUSSIONS
-
-### EVERYTHING IS SUBJECT TO CHANGE
-
-Please use [this](https://github.com/ajnart/homarr) version of Homarr when you want to use it

docs/README.md

@@ -0,0 +1,130 @@
+<!-- Project Title -->
+![Banner](./banner.png)
+
+<!-- Badges -->
+<p align="center">
+<img src="https://img.shields.io/github/stars/homarr-labs/homarr?label=%E2%AD%90%20Stars&style=flat-square?branch=master&kill_cache=1%22">
+<a href="https://github.com/homarr-labs/homarr/releases/latest">
+  <img alt="Latest Release (Semver)" src="https://img.shields.io/github/v/release/homarr-labs/homarr?label=%F0%9F%9A%80%20Release">
+</a>
+<a href="https://github.com/homarr-labs/homarr/actions/workflows/deployment-docker-image.yml">
+  <img title="Docker CI Status" src="https://github.com/homarr-labs/homarr/actions/workflows/deployment-docker-image.yml/badge.svg" alt="CI Status">
+</a>
+<a href=https://translate.homarr.dev/>
+<img title="Translations" src="https://badges.crowdin.net/homarr/localized.svg" />
+</a>
+<a href="https://discord.gg/aCsmEV5RgA">
+  <img title="Discord" src="https://discordapp.com/api/guilds/972958686051962910/widget.png?style=shield">
+</a>
+</p>
+
+<!-- Links -->
+<p align="center">
+  <a href="https://demo.homarr.dev/">
+    <strong>Demo ✨</strong>
+  </a>
+  •
+  <a href="https://homarr.dev/docs/getting-started/installation/">
+    <strong>Install 💻</strong>
+  </a> •
+  <a href="https://translate.homarr.dev/">
+    <strong>Translations 🈺</strong>
+  </a> •
+  <a href="https://discord.com/invite/aCsmEV5RgA">
+    <strong>Discord 👋</strong>
+  </a>
+</p>
+
+> [!WARNING]
+> This is a beta version of Homarr. You can download the old but stable version at https://github.com/ajnart/homarr/. Running this version is at your own risk.
+
+Simplify the management of your server with Homarr - a sleek, modern dashboard that puts all of your apps and services at your fingertips. With Homarr, you can access and control everything in one location. Homarr seamlessly integrates with the apps you've added, providing you with valuable information and giving you complete control. Installation is a breeze, and Homarr supports a wide range of deployment methods.
+
+<br/>
+<br/>
+
+![Features Section](./section-features.png)
+
+- 🖌️ Highly customizable with an extensive drag and drop grid system
+- ✨ Integrates seamlessly with your favorite self-hosted applications
+- 📌 Easy and fast app management - no YAML involved
+- 👤 Detailed and easy to use user management with permissions and groups
+- 👥 Support for single sign on via OIDC / LDAP
+- 🙊 Safe encryption using BCrypt and AES-256-CBC for your valuable data
+- 🕔 Realtime widget updates using WebSockets, tRPC and Redis
+- 🔍 Search through thousands of data points in supported integrations or your data in Homarr using the fast built-in search
+- 🦞 Icon picker with over 11K icons
+- 🚀 Compatible with any major consumer hardware (x86, Raspberry Pi, old laptops, ...) and most OS (Windows, Linux, TrueNAS, Unraid)
+- 🖥️ Extensive Kubernetes support with Helm for efficient scaling & high reliability
+
+<br/>
+<br/>
+
+![Widgets & Integrations Section](./section-widgets-and-integrations.png)
+
+Homarr has a [built-in collection of widgets and integrations](https://homarr.dev/docs/category/integrations), that connect to your applications and enable you to control them directly from the dashboard.
+
+- 📥 **Torrent clients**
+    - [Deluge](https://homarr.dev/docs/integrations/torrent#deluge)
+    - [Transmission](https://homarr.dev/docs/integrations/torrent#transmission)
+    - [qBittorent](https://homarr.dev/docs/integrations/torrent#qbittorrent-integration)
+- 📥 **Usenet clients**
+    - [SABnzbd](https://homarr.dev/docs/integrations/usenet#sabnzbd)
+    - [NZBGet](https://homarr.dev/docs/integrations/usenet#nzbget)
+- 📺 **Media servers**
+    - [Plex](https://homarr.dev/docs/integrations/media-server/#plex)
+    - [Jellyfin](https://homarr.dev/docs/integrations/media-server#jellyfin-and-emby)
+- 📚 **Media collection managers**
+    - [Sonarr](https://homarr.dev/docs/integrations/servarr#sonarr)
+    - [Radarr](https://homarr.dev/docs/integrations/servarr#radarr)
+    - [Lidarr](https://homarr.dev/docs/integrations/servarr#lidarr)
+    - [Readarr](https://homarr.dev/docs/integrations/servarr#readarr)
+- 🎞️ **Media request managers**
+    - [Overseerr](https://homarr.dev/docs/integrations/media-requester)
+    - [Jellyseerr](https://homarr.dev/docs/integrations/media-requester)
+- 🚫 **DNS ad-blockers**
+    - [Pihole](https://homarr.dev/docs/integrations/dns#pihole)
+    - [AdGuard Home](https://homarr.dev/docs/integrations/dns#adguard-home)
+- 🖥️ **Monitoring**
+    - [Dash.](https://homarr.dev/docs/integrations/hardware)
+    - [OpenMediaVault.](https://homarr.dev/docs/integrations/hardware/#openmediavault)
+    - [Proxmox.](https://homarr.dev/docs/integrations/hardware/#proxmox)
+- 🐳 **Container management**:
+    - [Docker](https://homarr.dev/docs/integrations/containers)
+
+<br/>
+<br/>
+
+![Installation Section](./section-installation.png)
+
+Since we are updating Homarr very frequently, we recommend reading our official installation guides:
+
+<h2>
+<a href="https://homarr.dev/docs/getting-started/installation/">
+  Please click here for official installation instructions
+</a>
+</h2>
+
+<br/>
+<br/>
+
+![Contribute Section](./section-contribute.png)
+
+<br/>
+
+Homarr is a free to use open source project that is maintained by volunteers and developers from all over the world. We publish under the ``Apache License 2.0`` license which allows commercial usage. We invest multiple hours daily in to providing support, developing Homarr, integrating to third party software and more. We also pay for licensing and server hosting fees.
+Please consider to help us cover these costs to enable the future development of Homarr. Thank you!
+
+<h2>
+<a href="https://opencollective.com/homarr">
+  Please click here to sponsor us at OpenCollective
+</a>
+</h2>
+
+You can also support us by helping with [translating the entire project](https://homarr.dev/docs/community/translations) to as many languages as possible or contributing directly to the code or documentation. Please read our [Contribution Guidelines](/CONTRIBUTING.md). All contributions, regardless of their size or scope, are welcome and highly appreciated! Thank you ❤️
+
+## Sponsors
+Thanks to your generous sponsors we can continue to build Homarr. Check them out for high quality and easy to use development tools.
+Feel free to contact us at homarr-labs@proton.me if you wish to become a sponsor.
+
+[![Covered by Argos Visual Testing](https://argos-ci.com/badge-large.svg)](https://argos-ci.com?utm_source=%5Bhomarr%5D&utm_campaign=oss)