From c4b3f1fe3f1f56e2a8f7b8b4d3d16ebe25f8811d Mon Sep 17 00:00:00 2001
From: Shiewk <shiewkmail@shiewk.de>
Date: Sun, 19 Apr 2026 18:35:18 +0200
Subject: [PATCH] docs: add description, usage, and configuration to readme

---
 README.md | 30 +++++++++++++++++++++++++++++-
 1 file changed, 29 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 1a67d60..4c117f6 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,30 @@
 # shy-launcher
-Utility for launching apps for Linux.
\ No newline at end of file
+
+**shy-launcher** is an utility for downloading assets and launching applications on Linux.
+
+## What can it do?
+It can:
+- Download assets over HTTP/S before the program starts
+- Verify that you have the latest version of your files/program/plugins
+- Change permissions for executable downloads
+
+## Configuration
+
+Below is an example `config.json`; adapt it to your needs:
+
+```json
+{
+    "name": "My Java server",
+    "run": "java",
+    "args": ["-jar", "server.jar"],
+    "downloads": [{
+        "method": "GET",
+        "url": "https://some.asset.server.shiewk.de/coolserver/latest/server.jar",
+        "headers": {
+            "Authorization": "Bearer tOk3n"
+        },
+        "filename": "server.jar",
+        "permissions": 700
+    }]
+}
+```
\ No newline at end of file