From 1d5e46fb564dffc3113052e2d86a0d5c540b07c2 Mon Sep 17 00:00:00 2001
From: Matthew Stobbs <matthew@stobbs.ca>
Date: Thu, 13 Mar 2025 00:43:36 -0600
Subject: [PATCH] add more to readme

---
 README.md | 37 +++++++++++++++++++++++++++++++------
 1 file changed, 31 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 39824c5..f2506cf 100644
--- a/README.md
+++ b/README.md
@@ -13,14 +13,25 @@ special handling.
 Order of precedence for package installation:
 
 1. System package manager (dnf, apt, homebrew, etc.)
-2. Appimage (Linux only)
-3. Flatpak (Linux only)
-4. Snap (Linux only), takes precedence over flatpak on Ubuntu based systems
-5. Language package manager (`cargo install`, `go install`, `npm install`, etc.)
-6. Build and install from source
+2. Source built - only in some situations, like for fast moving software (neovim)
+3. Appimage (Linux only)
+4. Flatpak (Linux only)
+5. Snap (Linux only), takes precedence over flatpak on Ubuntu based systems
+6. Language package manager (`cargo install`, `go install`, `npm install`, etc.)
 
 _This does not configure installed software, just installs it_
 
+To install any of the available packages, they must be part of a list called
+`packages`. Dependencies are handled on a best case basis.
+
+## Supported Operating Systems
+
+- Fedora Linux
+- MacOS
+- RHEL based distributions *Experimental* *best effort*
+- Debian *Experimental*
+- Alpine linux *Experimental* *best effort)
+
 ## Available Packages
 
 - air: hot reload for go #devtools #go
@@ -180,9 +191,23 @@ _This does not configure installed software, just installs it_
 
 ## Dependencies
 
-
 ## Example Playbook
 
+```yaml
+- name: Ensure packages are installed
+  vars:
+    packages:
+      - air
+      - go
+      - rust
+      - neovim
+  hosts: devmachines
+  gather_facts: true
+  tasks:
+    - name: Install given packages
+      ansible.builtin.inlude_role:
+        name: ansible_role_package
+```
 
 ## License