From 29fdcb488c4d7eee8da14bfe6ed22d8ecdc57fbc Mon Sep 17 00:00:00 2001
From: George Kaklamanos <gkaklas@gkaklas.gr>
Date: Sat, 12 Jul 2025 15:39:24 +0300
Subject: [PATCH] readme: Initial commit

Signed-off-by: George Kaklamanos <gkaklas@gkaklas.gr>
---
 README.md | 14 ++++++++++++++
 1 file changed, 14 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a5569ac
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# `hcloud-console.fish`
+
+To run it you just need `nix`: [gkak.la/nix-tutorial](https://gkak.la/nix-tutorial)
+
+```fish
+./console.fish <server name>
+```
+
+* Includes all dependencies
+* Requests a console using `hcloud`
+* Copies the password to the clipboard
+* Runs `novnc` locally
+* Opens `novnc` with the needed parameters in your browser
+* Just press "connect" and paste the password!