From 16e224d561713559045cf407b5cea8e795ca09aa Mon Sep 17 00:00:00 2001
From: pvincent <pvincent@artcode.re>
Date: Thu, 23 Oct 2025 01:53:38 +0400
Subject: [PATCH] README

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

diff --git a/README.md b/README.md
index e8a5348..eef962e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,18 @@
 # miaou-proxmox
 
+miaou-proxmox offers some utility tools able to perform the 'incus'-style commands.
+mostly command-line utilities.
+
+## how-to install
+
+> one-liner style
+
+```bash
+curl https://git.artcode.re/miaou/miaou-proxmox/raw/branch/main/install.sh | bash -s # NON-INTERACTIVE
+```
+
+> change default storage interactively
+
+```bash
+/opt/miaou-proxmox/install.sh
+```