From f196384904c2b271aa56af44be78c990eb16f427 Mon Sep 17 00:00:00 2001
From: colin <colin@git@nixc.us>
Date: Sun, 11 Aug 2024 18:38:06 -0400
Subject: [PATCH] Add README.md

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..321f973
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# Cloud Init Script
+
+This script automates the setup of a virtual machine using an Ubuntu Cloud Image in Proxmox, with the option to create a template and clone it.
+
+## Usage
+
+You can execute this script directly using `curl` with the following command:
+
+### Default Storage (`proxmox`)
+
+To run the script using the default storage (`proxmox`):
+
+```bash
+curl -sSL https://git.nixc.us/colin/cloud-init/install.sh | bash
+```
+
+### Specify a Different Storage
+
+If you want to specify a different storage, replace `other_storage_name` with your desired storage name:
+
+```bash
+curl -sSL https://git.nixc.us/colin/cloud-init/install.sh | bash -s -- other_storage_name
+```
+
+## Notes
+
+- The script is designed to exit immediately if any step fails, ensuring that errors are caught early.
+- The default storage location is set to `proxmox`, but it can be overridden by providing a different storage name as an argument.
+
+