From 4fe52c764de611dc292f0ee76f2c5af1ad051b91 Mon Sep 17 00:00:00 2001
From: Leo Vasanko <leo@git>
Date: Thu, 14 Aug 2025 10:40:32 -0700
Subject: [PATCH] Updated README for new version.

---
 README.md          | 55 +++++++++++++++++++++++++++-------------------
 frontend/README.md | 12 +++++-----
 2 files changed, 39 insertions(+), 28 deletions(-)

diff --git a/README.md b/README.md
index 56e7f33..016facd 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@ Cista takes its name from the ancient *cistae*, metal containers used by Greeks
 
 This is a cutting-edge **file and document server** designed for speed, efficiency, and unparalleled ease of use. Experience **lightning-fast browsing**, thanks to the file list maintained directly in your browser and updated from server filesystem events, coupled with our highly optimized code. Fully **keyboard-navigable** and with a responsive layout, Cista flawlessly adapts to your devices, providing a seamless experience wherever you are. Our powerful **instant search** means you're always just a few keystrokes away from finding exactly what you need. Press **1/2/3** to switch ordering, navigate with all four arrow keys (+Shift to select). Or click your way around on **breadcrumbs that remember where you were**.
 
+**Built-in document and media previews** let you quickly view files without downloading them. Document previews support various formats, while media previews include advanced **HDR support** for high dynamic range content, ensuring your videos and images are displayed with stunning visual quality.
+
 The Cista project started as an inevitable remake of [Droppy](https://github.com/droppyjs/droppy) which we used and loved despite its numerous bugs. Cista Storage stands out in handling even the most exotic filenames, ensuring a smooth experience where others falter.
 
 All of this is wrapped in an intuitive interface with automatic light and dark themes, making Cista Storage the ideal choice for anyone seeking a reliable, versatile, and quick file storage solution. Quickly setup your own Cista where your files are just a click away, safe, and always accessible.
@@ -16,36 +18,34 @@ Experience Cista by visiting [Cista Demo](https://drop.zi.fi) for a test run and
 ## Getting Started
 ### Installation
 
-To install the cista application, use:
+We recommend using [UV](https://docs.astral.sh/uv/getting-started/installation/) to install the package and run it:
 
 ```fish
-pip install cista
+uvx cista
 ```
 
-Note: Some Linux distributions might need `--break-system-packages` to install Python packages, which are safely installed in the user's home folder. As an alternative to avoid installation, run it with command `pipx run cista`
+Alternatively, you can install with `pip` or `uv pip`. This enables using the `cista` command directly without `uvx` or `uv run`.
+
+```fish
+pip install cista --break-system-packages
+```
 
 ### Running the Server
 
 Create an account: (or run a public server without authentication)
 ```fish
-cista --user yourname --privileged
+uvx cista --user yourname --privileged
 ```
 
 Serve your files at http://localhost:8000:
 ```fish
-cista -l :8000 /path/to/files
+uvx cista -l :8000 /path/to/files
 ```
 
 The server remembers its settings in the config folder (default `~/.local/share/cista/`), including the listen port and directory, for future runs without arguments.
 
 ### Internet Access
 
-To use your own TLS certificates, place them in the config folder and run:
-
-```fish
-cista -l cista.example.com
-```
-
 Most admins instead find the [Caddy](https://caddyserver.com/) web server convenient for its auto TLS certificates and all. A proxy also allows running multiple web services or Cista instances on the same IP address but different (sub)domains.
 
 `/etc/caddy/Caddyfile`:
@@ -56,33 +56,44 @@ cista.example.com {
 }
 ```
 
+Nxing or other proxy may be similarly used, or alternatively you can run `cista -l cista.example.com` with cert and key placed in the cista config dir.
+
 ## Development setup
 
 For rapid development, we use the Vite development server for the Vue frontend, while running the backend on port 8000 that Vite proxies backend requests to. Each server live reloads whenever its code or configuration are modified.
 
+Make sure you have git, uv and bun (or npm) installed.
+
+Backend (Python) – setup and run:
+
+```fish
+git clone https://git.zi.fi/Vasanko/cista-storage.git
+cd cista-storage
+uv sync --dev
+uv run cista --dev -l :8000 /path/to/files
+```
+
+Frontend (Vue/Vite) – run the dev server in another terminal:
+
 ```fish
 cd frontend
-npm install
-npm run dev
+bun install
+bun run dev
 ```
 
-Concurrently, start the backend on another terminal:
+Building the package for release (frontend + Python wheel/sdist):
 
 ```fish
-hatch shell
-pip install -e '.[dev]'
-cista --dev -l :8000 /path/to/files
+uv build
 ```
 
-We use `hatch shell` for installing on a virtual environment, to avoid disturbing the rest of the system with our hacking.
-
-Vue is used to build files in `cista/wwwroot`, included prebuilt in the Python package. Running `hatch build` builds the frontend and creates a NodeJS-independent Python package.
+Vue is used to build files in `cista/wwwroot`, included prebuilt in the Python package. `uv build` runs the project build hooks to bundle the frontend and produce a NodeJS-independent Python package.
 
 ## System Deployment
 
 This setup allows easy addition of storages, each with its own domain, configuration, and files.
 
-Assuming a restricted user account `storage` for serving files and that cista is installed system-wide or on this account (check with `sudo -u storage -s`). Alternatively, use `pipx run cista` or `hatch run cista` as the ExecStart command.
+Assuming a restricted user account `storage` for serving files and that UV is installed system-wide or on this account. Only UV is required: this does not use git or bun/npm.
 
 Create `/etc/systemd/system/cista@.service`:
 
@@ -92,7 +103,7 @@ Description=Cista storage %i
 
 [Service]
 User=storage
-ExecStart=cista -c /srv/cista/%i -l /srv/cista/%i/socket /media/storage/%i
+ExecStart=uvx cista -c /srv/cista/%i -l /srv/cista/%i/socket /media/storage/%i
 Restart=always
 
 [Install]
diff --git a/frontend/README.md b/frontend/README.md
index 996a7ac..c76116e 100644
--- a/frontend/README.md
+++ b/frontend/README.md
@@ -22,25 +22,25 @@ If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has a
 ### Run the backend
 
 ```fish
-hatch shell
-cista --dev -l :8000
+uv sync --dev
+uv run cista --dev -l :8000
 ```
 
 ### And the Vite server (in another terminal)
 
 ```fish
 cd frontend
-npm install
-npm run dev
+bun install
+bun run dev
 ```
 Browse to Vite, which will proxy API requests to port 8000. Both servers live reload changes.
 
 
 ### Type-Check, Compile and Minify for Production
 
-This is also called by `hatch build` during Python packaging:
+This is also called by `uv build` during Python packaging:
 
 ```fish
-npm run build
+bun run build
 ```