Update README.md

README.md

@@ -1,44 +1,59 @@
 # mitchell's dotfiles
 
-This mostly exists for my convenient bootstrapping onto new systems, but it should be generalized
+This mostly exists for my convenient bootstrapping onto new systems. I would generally recommend
-enough for anyone to use it.
+drawing from individual applications' configurations as inspiration for your own dotfiles. However,
+the included scripts should be generalized enough to work on anybody's machines.
 
 This repo contains my preferred configurations for:
+
 - fish shell
-- vim
+- neovim
 - tmux
 - git
-- yabai wm
+- kitty terminal
-- skhd
+- Jetbrains vim plugin
-- kitty term
+- keepassxc
+- qutebrowser
+- bspwm (Linux)
+- sxhkd (Linux)
+- yabaiwm (macOS)
+- skhd (macOS)
 
-Which also implies they are all dependencies to use the whole configuration.
+## Scripts
+
+### `sync`
+
+**Dependencies**
 
-Installation dependencies:
-- git
 - fish
-- rsync (for sync script)
+- git
+- neovim
+- rsync
 - curl
 
-To install from fish shell: `curl https://raw.githubusercontent.com/mitchell/dotfiles/master/sync | .`
+**Description**
 
-To install all of the configuration from bash and then change default shell:
+Syncs all configuration files found in this repository to your home folder.
-1. Clone this repo with the `--recurse-submodules` flag.
-1. `cd` into your clone and run the `sync` script (requires fish be installed).
-1. If you haven't already either run `fish` or change your default shell by appending the result of
-   `which fish` to `/etc/shells` and running `chsh -s /path/to/fish yourusername`, then restarting
-   the terminal.
-1. Enjoy!
 
-Dependencies for fish aliases:
+To run sync script using curl: `curl https://raw.githubusercontent.com/mitchell/dotfiles/master/sync | fish`
-- fzf (used in `v`)
-- ag (used in `vs`)
 
-Dependencies for prompt info (only needed in relevant projects):
+### `upgrade_debian`
-- golang
+
-- docker
+**Dependencies**
-- node
+
-- typescript
+- fish
-- elixir
+
-- dart
+**Description**
-- flutter
+
+Upgrade from Debian stable to unstable.
+
+### `provision_debian`
+
+Dependencies
+
+- fish
+
+**Description**
+
+Provision various environments and tools on Debian. Run `./run help` and peek inside for more
+information.