From 4055d0d62ad9c9169d637d9320d8011dee541869 Mon Sep 17 00:00:00 2001
From: Ben Hays <ben@benhays.org>
Date: Sat, 27 Jan 2024 19:36:52 -0500
Subject: [PATCH] Add more documentation

---
 README.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/README.md b/README.md
index 79c1a6e..9b4ef02 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,15 @@
 # Homelab Automation
 
 This is a repo containing some of the PowerShell/Bash scripts and Ansible playbooks I've written and utilized within my personal network/homelab. Most of the scripts/playbooks should be self-explanatory by the name alone, but there's (hopefully) descriptions and comments in each file to explain the purpose and actions taken by each script.
+
+## Using Ansible Playbooks
+For any given Ansible playbook, say for example `openssl.yml`, the generic command-line options for running it would be:
+```bash
+ansible-playbook -i inventory.ini openssh.yml --ask-become-pass
+```
+
+## Using Shell Scripts
+Most/all of the shell scripts will display a usage list of arguments and options when called incorrectly or without arguments. As an example, see ssh-compliance.sh:
+```
+Usage: ssh-compliance.sh (--install-deps) (--docker) <file-with-hosts>
+```
\ No newline at end of file