From 8d5b0b85ca2ef4ff7892dc1cd24d4965c8ab379b Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Mon, 23 Mar 2026 16:12:58 +0000
Subject: [PATCH 1/2] Initial plan


From c394120a62a430628653d10895bc0206b8b707e0 Mon Sep 17 00:00:00 2001
From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com>
Date: Mon, 23 Mar 2026 16:14:55 +0000
Subject: [PATCH 2/2] docs: add installation instructions and usage examples to
 README

Co-authored-by: szmyty <14865041+szmyty@users.noreply.github.com>
Agent-Logs-Url: https://github.com/egohygiene/renderflow/sessions/97c3ad0e-7504-411e-b988-33adb517e200
---
 README.md | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 60 insertions(+)

diff --git a/README.md b/README.md
index 01f8e96..62ff75d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,62 @@
 # renderflow
 ✨ Spec-driven document rendering engine (Markdown → PDF/HTML/LaTeX)
+
+## Installation
+
+### Download from GitHub Releases (recommended)
+
+Pre-built binaries are available for Linux, macOS, and Windows on the [Releases page](https://github.com/egohygiene/renderflow/releases).
+
+**Linux:**
+```bash
+curl -L https://github.com/egohygiene/renderflow/releases/latest/download/renderflow-linux -o renderflow
+chmod +x renderflow
+sudo mv renderflow /usr/local/bin/
+```
+
+**macOS:**
+```bash
+curl -L https://github.com/egohygiene/renderflow/releases/latest/download/renderflow-macos -o renderflow
+chmod +x renderflow
+sudo mv renderflow /usr/local/bin/
+```
+
+**Windows:**
+
+Download `renderflow-windows.exe` from the [Releases page](https://github.com/egohygiene/renderflow/releases/latest) and place it somewhere on your `PATH`.
+
+### Build from source (requires [Rust](https://rustup.rs))
+
+```bash
+cargo install --path .
+```
+
+## Usage
+
+```bash
+# Render using the default renderflow.yaml config
+renderflow build
+
+# Render using a custom config file
+renderflow build --config custom.yaml
+
+# Shorthand: pass the config file directly (equivalent to renderflow build --config my-project.yaml)
+renderflow my-project.yaml
+
+# Preview what would be built without creating any files
+renderflow build --dry-run
+```
+
+> **Note:** The argument to `renderflow` is always a YAML configuration file. The Markdown file to render is specified inside the config under the `input` key (e.g. `input: "input.md"`).
+
+### Configuration
+
+Renderflow is driven by a YAML configuration file (default: `renderflow.yaml`):
+
+```yaml
+input: "input.md"
+output_dir: "dist"
+outputs:
+  - type: pdf
+  - type: html
+```