From efa26131ec04bb9c8cd12a63707f933e4c78ad59 Mon Sep 17 00:00:00 2001
From: Chris Toph <toph@ryot.foo>
Date: Sun, 27 Apr 2025 16:24:48 -0400
Subject: [PATCH] Add README.md with project overview, installation
 instructions, and command usage

---
 readme.md | 171 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 171 insertions(+)
 create mode 100644 readme.md

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..1500d8f
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,171 @@
+# Yay.nix
+
+Yay.nix (Yet another Yay) is a simple wrapper around useful commands I use all the time and can't be bothered to keep typing. I also just miss writing yay in terminal.
+
+## Overview
+
+Yay.nix provides simple, user-friendly commands for common Nix operations like rebuilding your flake config, updating flakes, garbage collection, and more. It includes fish shell completions for all commands and options, making it faster and easier to work with Nix.
+
+## Installation
+
+### As a Flake
+
+Add to your flake.nix:
+
+```nix
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    yay-nix = {
+      url = "github:Tophc7/yay.nix";
+      inputs.nixpkgs.follows = "nixpkgs";
+    };
+  };
+
+  outputs = { self, nixpkgs, yay-nix, ... }: {
+    # For NixOS system configuration
+    nixosConfigurations.<yourhostname> = nixpkgs.lib.nixosSystem {
+      # ...
+      modules = [
+        yay-nix.nixosModules.default
+        # ...
+      ];
+    };
+  };
+}
+```
+
+### With Home Manager
+
+```nix
+{
+  imports = [
+    inputs.yay-nix.homeManagerModules.default
+  ];
+}
+```
+
+## Commands
+
+### rebuild
+
+Rebuild your NixOS configuration.
+It will look for a flake in this pattern: `-p <PATH> > $FLAKE > ./`
+
+```bash
+yay rebuild [OPTIONS]
+```
+
+Options:
+- `-p, --path PATH`: Path to the Nix configuration (overrides FLAKE env var)
+- `-H, --host HOST`: Hostname to build for (default: current hostname)
+- `-t, --trace`: Enable trace output
+- `-h, --help`: Show help message
+
+### update
+
+Update flake inputs.
+
+```bash
+yay update [OPTIONS]
+```
+
+Options:
+- `-p, --path PATH`: Path to the Nix configuration (overrides FLAKE)
+- `-h, --help`: Show help message
+
+
+TODO:
+- update specific inputs
+- autocomplete for those inputs
+
+### garbage
+
+Clean up the Nix store and home-manager backups.
+Super overkill don't come for me if something goes wrong. Regardless I use it all the time. 
+
+```bash
+yay garbage
+```
+
+This command:
+1. Cleans using `nh clean all` (with and without sudo)
+2. Runs `nix-collect-garbage --delete-old` (with and without sudo) 
+3. Executes `nix-store --gc` (with and without sudo)
+4. Removes home-manager backup files
+
+### try
+
+Create a shell with specified packages.
+
+```bash
+yay try PACKAGE [PACKAGE...]
+```
+
+Example:
+```bash
+yay try fastfetch cowsay
+```
+
+TODO:
+- allow `--` to run command directly  
+
+### tar
+
+Create compressed archives with various compression methods.
+
+```bash
+yay tar [OPTIONS] INPUT_PATH [OUTPUT_PATH]
+```
+
+Options:
+- `-c, --compression TYPE`: Compression type (default: zstd)
+- `-l, --level N`: Compression level where applicable
+- `-o, --output PATH`: Output file path
+- `-t, --threads N`: Number of threads to use where supported
+- `-v, --verbose`: Enable verbose output
+- `-h, --help`: Show help message
+
+Supported compression types:
+- `7zip`:   .7z (levels: 0-9, default 5)
+- `bzip2`:  .tar.bz2 (levels: 1-9, default 9)
+- `bzip3`:  .tar.bz3 (block size in MiB: 1-511, default 16)
+- `gzip`:   .tar.gz (levels: 1-9, default 6)
+- `tar`:    .tar (no compression)
+- `zstd`:   .tar.zst (levels: 1-19, default 3)
+
+### untar
+
+Extract various archive formats.
+
+```bash
+yay untar [OPTIONS] ARCHIVE [OUTPUT_DIR]
+```
+
+Options:
+- `-o, --output DIR`: Output directory 
+- `-v, --verbose`: Enable verbose output
+- `-h, --help`: Show help message
+
+Supported archive formats (auto-detected from extension):
+- `.7z`, `.tar.7z` (7-Zip)
+- `.tar.bz2`, `.tb2`, `.tbz`, `.tbz2`, `.tz2` (bzip2)
+- `.tar.bz3` (bzip3)
+- `.tar.gz`, `.tgz` (gzip)
+- `.rar` (RAR)
+- `.tar` (uncompressed tar)
+- `.tar.zst`, `.tzst` (zstd)
+
+### more?
+
+If theres a command you think would be useful to add let me know, I might agree.
+
+## Technical Details
+
+Yay.nix is implemented as a collection of fish functions that are installed into your system's fish function path. The main `yay` command is a bash script that invokes fish with the correct environment to execute the functions.
+
+All commands and options have competitions making the tool easy to use interactively
+
+## License
+
+MIT
\ No newline at end of file