From 4293324f36e41d710b75aa1eb37b82ddeae07319 Mon Sep 17 00:00:00 2001
From: iofq <cjriddz@protonmail.com>
Date: Sun, 28 Jan 2024 18:00:06 -0600
Subject: [PATCH] Update README

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++--
 1 file changed, 39 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 34319cb..a9b580e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,39 @@
-# home-manager flake for neovim, tmux, etc. 
-Very much still in progress
+# Nix config including NixOS, home-manager and infrastructure using deploy-rs
+
+## Starting
+
+```bash
+nix develop "github:iofq/nix"
+```
+
+## Nixos
+
+### Building for local machine
+```bash
+nixos-rebuild switch --flake .#name
+```
+### Building remote hosts
+```bash
+nixos-rebuild switch --flake .#name --target-host host
+```
+
+### Building remote hosts using deploy-rs
+```bash
+nix develop
+deploy .
+```
+
+## Home-manager
+
+```bash
+home-manager switch --flake "github:iofq/nix#t14"
+```
+
+## Developing
+
+```
+direnv allow
+nix fmt
+```
+
+Direnv will also set up git pre-commit hooks to format the repo automatically.