feat: added gpg.conf and cleaned up repo

1 files changed, 56 insertions, 10 deletions

diff --git a/README.md b/README.md
index 4c67205..7bf7841 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,64 @@
-# tobyvin's dotfiles
+tobyvin's dotfiles
+==================
 
-### Installation
+
+Install
+-------
+
+Clone the repo and its submodules, then install links.
 
 ```sh
 git clone https://github.com/tobyvin/dotfiles.git ~/dotfiles && ~/dotfiles/install
 ```
 
-## Configs
+The install **will override** the following configs by default:
+- ~/.zshrc
+- ~/.p10k.zsh
+- ~/.gitconfig
+- ~/.ssh/config
+- ~/.gnupg/gpg.conf
+
+
+To disable overwriting existing configs, set `defaults.link.force` in [install.conf.yaml](install.conf.yaml) to `false`:
+
+```yaml
+# file: install.conf.yaml
+- defaults:
+    link:
+      create: true
+      relink: true
+      force: false <--
+```
 
-- **gitconfig**
-- **ssh/config**
-- **zshrc**: sources various config scripts and calls antigen to load plugins
-- **zsh/***: various zsh configuration scripts
-- **p10k.zsh**: zsh theme config 
-- **antigen**: plugin manager that installs/updates zsh plugins
-- **fzf**: fuzzy finder that integrates with zsh history/autocompletion
+Configs
+-------
+
+#### Zsh Configuration
+- [zshrc](zshrc) - Zsh profile (sources [zsh/*](zsh))
+- [p10k.zsh](p10k.zsh) - p10k theme config 
+- [zsh/](zsh) - Zsh configuration scripts
+  - [aliases.zsh](zsh/aliases.zsh) - Alias definitions and related functions 
+  - [antigen.zsh](zsh/antigen.zsh) - Loads Antigen plugins and theme
+  - [keybindings.zsh](zsh/keybindings.zsh) - Keybindings and related functions
+  - [prompt.zsh](zsh/prompt.zsh) - Prompt configuration and prompt theme settings 
+  - [setopt.zsh](zsh/setopt.zsh) - Zsh configuration settings
+  - [wsl.zsh](zsh/wsl.zsh) - WSL2 specific Zsh configuration
+
+#### Misc
+
+- [gitconfig](gitconfig) - Git configuration
+- [ssh/](ssh) - SSH related files
+  - [config](ssh/config) - SSH configuration
+  - [wsl2-ssh-pageant](ssh/wsl2-ssh-pageant.exe) - connects SSH/GPG sockets between WSL2 and Windows
+- [gnupg/](gnupg) - GnuPG (GPG) related files
+  - [gpg.conf](gnupg/gpg.conf) - GPG configuration
   
+Submodules
+----------
+
+- ### [Dotbot](https://github.com/anishathalye/dotbot) - A tool that bootstraps your dotfiles ⚡️
+
+#### Zsh:
+- [antigen](https://github.com/zsh-users/antigen) - The plugin manager for zsh.
+- [fzf](https://github.com/junegunn/fzf) - 🌸 A command-line fuzzy finder
+- [p10k](https://github.com/romkatv/powerlevel10k) - A Zsh theme
\ No newline at end of file