From 4111f31ce60a99c087dd001662a71f68a2cd7913 Mon Sep 17 00:00:00 2001
From: Rostyslav Hnatyshyn <rostyslav.hnatyshyn@gmail.com>
Date: Fri, 20 Sep 2024 20:51:01 -0700
Subject: [PATCH] update readme

---
 README.md | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 5554bc0..909b96d 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,11 @@
+# Dotfiles
 Set of dotfiles I use for my desktop. I run Arch linux (btw) and use `i3` compiled with no gaps, `alacritty` as my terminal emulator and `neovim` as my text editor. I also like to manage my notes using `obsidian`. I spend 99% of my time on my computer using those 4 programs plus `firefox`. 
 
 <p align="center">
     <img src="desktop.png" width="1000"/>
 </p>
 
-People will likely find the `nvim`, `alacritty`, and `zshrc` / `p10k.zsh` useful.
+People will likely find the `nvim`, `alacritty`, and `zshrc` / `p10k.zsh` configs useful.
+
+# Installation
+If you want to just use my entire setup as-is, you can run `install.sh`. This will symlink all of the files in this directory to your home directory. Folders get linked to `~/.config` and files get linked as hidden versions of their names under `$HOME` (e.g. `zshrc` -> `~/.zshrc`).