From f2d0ff24d09456ea75746bd5be1ee8efbc352046 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sandro=20J=C3=A4ckel?= <sandro.jaeckel@gmail.com>
Date: Tue, 3 Jan 2023 05:13:16 +0100
Subject: [PATCH] Update readme

- add usage, design idea
- update other projects
---
 README.md | 33 +++++++++++++++++++++++++++------
 1 file changed, 27 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 5f7733f..79a83a3 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,32 @@
-# nixos-modukles
+# nixos-modules
 
-Opinionated shared nixos configurations.
+Opinionated shared NixOS configurations.
 
-# Usage
+## Usage
 
-TODO
+Add or merge the following settings to your `flake.nix`:
 
-# Similar projects
+```nix
+{
+  inputs = {
+    nixos-modules.url = "github:SuperSandro2000/nixos-modules";
+  };
 
-- https://github.com/numtide/srvos
+  outputs = { nixos-modules }: {
+    nixosConfigurations.HOSTNAME = {
+      modules = [
+       nixos-modules.nixosModule
+    ];
+  };
+}
+```
+
+## Design
+
+* Modules should never change the configuration without setting an option
+* Unless the global overwrite ``opinionatedDefaults = true`` is set which activates most settings.
+
+## Similar projects
+
+* https://github.com/numtide/srvos
+* https://gitea.c3d2.de/C3D2/nix-user-module