From cee780bc2f29da17e25a8ef5df9e71cb83ee0367 Mon Sep 17 00:00:00 2001
From: Julien Malka <julien.malka@me.com>
Date: Thu, 23 Dec 2021 23:57:26 +0100
Subject: [PATCH] Still a WIP but better

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f6390cd..3d2f6c0 100644
--- a/README.md
+++ b/README.md
@@ -8,4 +8,27 @@ NixOS is a linux distribution based on the Nix package manager. It allows fully
 
 ### *What is a flake ?*
 
-This whole repository is a flake. It is an experimental feature of Nix.
+This whole repository is a flake. It is an experimental feature of Nix, allowing for pure evaluation of code. Dependency are fully specified and locked.
+
+### *How does this work ?*
+
+#### Machines 
+
+This project manage the configuration of three machines :
+- **Macintosh**, a thinkpad laptop,
+- **Lisa**, a high performance server,
+- **Newton**, a low performance stockage server.
+
+Machines configurations are located in the machines folder, and are using all the custom modules defined in this project.
+
+#### Modules
+
+This configuration defines a number of custom NixOS and home-manager modules. They are respectively defined in the modules and home-manager-modules folders.
+
+#### Secrets
+
+Secrets are stored in the secrets folder. They are decrypted upon system activation using the host ssh key.
+
+### Inspiration 
+
+This project is freely inspired by some really cool projects, including MayNiklas/nixos, pinox/nixos and ncfavier/config.