From 6e84ea98e49724b5313fd4078cad5a215d063ea9 Mon Sep 17 00:00:00 2001
From: Glen Goodwin <glen.goodwin1992@gmail.com>
Date: Thu, 9 Nov 2023 01:05:09 -0500
Subject: [PATCH] chore: update readme

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..277fe4d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# NixOS Flake Configuration
+
+## Overview
+
+This repository contains my NixOS configuration as a flake. This configuration is designed to provide a reproducible and declarative setup for my system. It includes system configuration, package management, and various other NixOS features.
+
+### Window Manager
+ - hyrpland
+ - waybar
+ - swaylock
+ - wofi
+ - light
+ - grimshot
+ - mako 
+
+### Terminal
+ - alacritty
+ - zsh
+ - starship
+ - tmux
+ - neovim(my configuration can be found [here](https://github.com/gwg313/nvim-nix))
+ - eza
+ - ripgrep
+ - fd
+## Prerequisites
+
+Before using this NixOS flake configuration, you should have the following prerequisites:
+
+ - NixOs should be installed on your system.
+ - Familiarity with Nix and NixOS concepts is helpful but not required.
+
+## Usage
+
+This section should provide guidance on using and managing your NixOS configuration.
+
+To rebuild and switch to the new configuration:
+
+```bash
+nixos-rebuild switch --flake .#thinkpad
+```
+