Update README.md

Author: lukasl-dev

README.md

@@ -1 +1,62 @@
 # nixos
+
+<div align="center">
+    <img src="https://img.shields.io/badge/Uses-Flake-4c72bb?style=for-the-badge&logo=nixos" alt="Nix" />
+    <img src="https://img.shields.io/badge/Desktop-Hyprland-00c0e5?style=for-the-badge&logo=hyprland" alt="Python" />
+</div>
+
+<br />
+
+This is my personal [NixOS](https://nixos.org/) configuration for my desktops and servers.
+
+> [!IMPORTANT]
+> I do not recommend anyone to use it since it is heavily personalised to my needs. However, the reason I share this repository is to simplify my deployments and allow others, especially new NixOs users, to explore different config structures to choose the best of all worlds.
+
+![Preview](./docs/preview.png)
+
+## Synopsis
+
+After restructuring my config over and over again, I came up with the following structure, which works for me very good at the moment:
+
+```
+.
+├── docs
+│   └── documentation-related files, e.g. screenshots, ...
+├── dots
+│   └── dotfiles, e.g. neovim, ghostty, ...
+├── home
+│   ├── desktop
+│   │   └── home-manager config for desktop hosts
+│   ├── headless
+│   │   └── home-manager config for non-desktop hosts, e.g. servers
+│   └── shared config for both desktop and headless hosts
+├── hosts
+│   ├── desktops
+│   │   ├── orion
+│   │   │   └── nixos config for the orion desktop host
+│   │   ├── vega
+│   │   │   └── nixos config for the vega desktop host
+│   │   └── shared config for all desktop hosts
+│   ├── servers
+│   │   ├── sirius
+│   │   │   └── nixos config for the sirius server host
+│   │   └── shared config for all server hosts
+│   └── shared config for both desktops servers
+├── modules
+│   └── nixos modules for various services and apps
+├── scripts
+│   └── useful scripts
+├── secrets
+│   └── sops secret files
+├── wallpapers
+│   └── wallpapers used by desktop hosts
+```
+
+## Credits
+
+This configuration takes advantage of some other repositories, including:
+
+- [sops](https://github.com/Mic92/sops-nix)
+- [home-manager](https://github.com/nix-community/home-manager)
+- [hyprland](https://github.com/hyprwm/Hyprland)
+- [wallpapers](./wallpapers/README.md)

docs/preview.png

@@ -1,7 +1,5 @@
 {
-  meta,
   inputs,
-  config,
   pkgs,
   pkgs-unstable,
   ...