From a30fa8b061b6f0201cf4a856ae0ac2dcf003e7be Mon Sep 17 00:00:00 2001
From: luxick <git@luxick.de>
Date: Fri, 8 May 2026 10:16:40 +0200
Subject: [PATCH] Update Readme

---
 README.md | 36 ++++++++++++++++++++++--------------
 1 file changed, 22 insertions(+), 14 deletions(-)

diff --git a/README.md b/README.md
index 93f584f..631eadc 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,17 @@
 
 Minimal self-hosted personal wiki. Folders are pages.
 
-## Run
+## Features
 
-```bash
-go run . -dir ./wiki -addr :8080
-go run . -dir ./wiki -addr :8080 -user me -pass secret
-```
+- **Pages** every folder is a page. Place an `index.md` inside a folder and it renders as HTML. Drop any other files (PDFs, images, etc.) alongside it and they appear in the listing below the content. Navigating to a path that does not exist shows a **[CREATE]** prompt.
+
+- **Search** search across all page names (folder names) in the wiki, accessible from the navigation bar.
+
+- **Wikilinks** link between pages with `[[Page Name]]` syntax. When a page is renamed or moved, all wikilinks pointing to it are rewritten automatically to reflect the new path.
+
+- **Movie import** import movie entries via the OMDb API. Fetches title, year, runtime, genre, director, cast, plot, and poster, and pre-fills a new page with that metadata.
+
+- **Special folder types** folders can opt into custom rendering (e.g. a photo diary with calendar navigation). See the [Special Folder Types](#special-folder-types) section for details.
 
 ## Build
 
@@ -21,16 +26,19 @@ GOOS=linux GOARCH=arm go build -o datascape .
 
 ## Usage
 
-| Action | How |
-|--------|-----|
-| Browse | Navigate folders at `/` |
-| Read | Any folder with `index.md` renders it as HTML |
-| Edit | Append `?edit` to any folder URL, or click **[EDIT]** (Alt+Shift+E) |
-| Save | POST from the edit form writes `index.md` to disk; folder is created if needed |
-| New page | Click **[NEW]** (Alt+Shift+N), enter a name — opens the new page in edit mode |
-| Files | Drop PDFs, images, etc. next to `index.md` — they appear in the listing |
+```bash
+go run . -dir ./wiki -addr :8080
+go run . -dir ./wiki -addr :8080 -user me -pass secret
+```
 
-Navigating to a URL that does not exist shows an empty page with a **[CREATE]** prompt.
+| Flag | Default | Description |
+|------|---------|-------------|
+| `-addr` | `:8080` | Listen address |
+| `-dir` | `./wiki` | Wiki root directory |
+| `-cache` | `./cache` | Thumbnail cache directory |
+| `-user` | _(none)_ | Basic auth username — omit to disable auth |
+| `-pass` | _(none)_ | Basic auth password |
+| `-reindex-interval` | `30m` | Periodic search index rebuild interval (`0` disables) |
 
 ## Special Folder Types