From 3c5b255bcfec060e05af507e43919fb1db2bd78a Mon Sep 17 00:00:00 2001
From: Andrejus <git@andrejus.uk>
Date: Sun, 3 Mar 2024 21:06:00 +0000
Subject: [PATCH] feat: bump docs

---
 README.md    | 52 ++++++++++++++++++++++++++--------------------------
 script/setup | 12 ------------
 2 files changed, 26 insertions(+), 38 deletions(-)

diff --git a/README.md b/README.md
index b63acd7..02dbe53 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,10 @@
 # andrejusk/dotfiles
 
-[![Dotfiles CI](https://github.com/andrejusk/dotfiles/actions/workflows/ci.yml/badge.svg)](https://github.com/andrejusk/dotfiles/actions/workflows/ci.yml)
+[![Dotfiles CI status badge](https://github.com/andrejusk/dotfiles/actions/workflows/ci.yml/badge.svg)](https://github.com/andrejusk/dotfiles/actions/workflows/ci.yml)
 
 My collection of dotfiles and install scripts
-to set up reproducible dev environments
+to set up development environments
+🛠️ 📂️ 🚀
 
 ## Usage
 
@@ -11,7 +12,17 @@ A local repository can be installed by running:
 
     ./script/install
 
-### Automated install
+<details>
+<summary>
+Environment configuration for <code>install</code> script
+</summary>
+
+| Variable | Description |
+| --- | --- |
+| `LOG_TARGET` | File to log installation output to (default: `~/.dotfiles/logs/install-{date}.log`) |
+</details>
+
+### Automated setup
 
 This repository can be installed without a local copy
 by invoking the `setup` script directly via `curl`:
@@ -22,28 +33,17 @@ by invoking the `setup` script directly via `curl`:
     # Run
     curl -s https://raw.githubusercontent.com/andrejusk/dotfiles/HEAD/script/setup | bash
 
-## Features
 
-My dotfiles include configuration for the following tools:
+<details>
+<summary>
+Environment configuration for <code>setup</code> script
+</summary>
 
-### Shell
-
-- zsh
-
-### Editor
-
-- vscode
-
-### Languages
-
-- node.js (nvm, yarn)
-- python (pyenv, poetry)
-
-### Tools
-
-- git, gh
-- docker
-- terraform (+ ls)
-- gcloud, firebase, awscli
-- redis cli
-- kubectl
+| Variable | Description |
+| --- | --- |
+| `DOTFILES_DIR` | Directory to clone the repository into (default: `~/.dotfiles`)
+| `DOTFILES_SKIP_INSTALL` | Skip running the install script (default: `false`)
+| `GITHUB_AUTHOR` | GitHub username to use for cloning repositories (default: `andrejusk`) |
+| `GITHUB_REPO` | GitHub repository name to clone (default: `dotfiles`)
+| `GITHUB_BRANCH` | GitHub branch to clone (default: `master`)
+</details>
diff --git a/script/setup b/script/setup
index 55b2931..57e1fa4 100755
--- a/script/setup
+++ b/script/setup
@@ -5,18 +5,6 @@ set -eo pipefail
 # Summary: Script to checkout a compatible
 # repository and run `script/install`
 #
-# Optional arguments:
-#   GITHUB_AUTHOR: GitHub author of repository
-#    Defaults to "andrejusk"
-#   GITHUB_REPOSITORY: GitHub repository name
-#    Defaults to "dotfiles"
-#   GITHUB_BRANCH: GitHub branch name
-#    Defaults to "master"
-#   DOTFILES_DIR: Directory to install dotfiles to
-#    Defaults to "$HOME/.dotfiles"
-#   DOTFILES_SKIP_INSTALL: Skip running `script/install`
-#    Defaults to false
-#
 # Required binaries:
 #   curl
 #   tar