From ae75c299cbf0d1f937207f172cc4b52c24de13b0 Mon Sep 17 00:00:00 2001
From: Ivan Kirilov Dimitrov <ivan@idimitrov.dev>
Date: Sat, 3 Aug 2024 17:43:30 +0200
Subject: [PATCH] README

---
 README.md | 31 +++++++++++++++++--------------
 1 file changed, 17 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index d0c1d27..6a64016 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,23 @@
-# My personal nixos config.
+# NixOS configurations
 
-### Usage
+This repository aims to configure everything I use for all my machines.
 
-To build the nixos system:
+### Goals
 
+- Provide me with something that I personally can use.
+- Make it modular so that it can be reused by other people or me on other people's machines (my company's workstation).
+
+### How to use
+
+[Check the home-manager modules](./home/modules/default.nix)
+[Check the NixOS modules](./nixos/modules/default.nix)
+
+These are exposed in the following way
+`<this-flake>.homeManagerModules.<module>`
+`<this-flake>.nixosModules.<module>`
+
+Run the following for more info:
 ```bash
-make nixos
+nix flake show github:ivandimitrov8080/configuration.nix
 ```
 
-To build ivand home:
-
-```bash
-make home
-```
-
-To make music:
-```bash
-make music # this will compile the realtime kernel
-```